router/bgp

Resource URIs

URI Description
<base_URI>/config/running/router/bgp Border Gateway Protocol (BGP).
GET URIs Description
<base_URI>/config/running/router/bgp Border Gateway Protocol (BGP).
<base_URI>/config/running/router/bgp/local-as Displays local AS number.
<base_URI>/config/running/router/bgp/always-compare-med Displays whether the device is set to always compare the Multi-Exit Discriminators (MEDs).
<base_URI>/config/running/router/bgp/compare-med-empty-aspath Displays whether comparison of Multi-Exit Discriminators (MEDs) for internal routes is enabled.
<base_URI>/config/running/router/bgp/med-missing-as-worst Considers routes missing MED attributes as least desirable.
<base_URI>/config/running/router/bgp/as-path-ignore Displays whether the comparison of the autonomous system (AS) path lengths of otherwise equal paths is enabled.
<base_URI>/config/running/router/bgp/compare-routerid Displays whether comparison of device IDs is enabled.
<base_URI>/config/running/router/bgp/install-igp-cost Enables the device to use the IGP cost instead of the default BGP4 or BGP4+ Multi-Exit Discriminator (MED) value.
<base_URI>/config/running/router/bgp/cluster-id Configures Route-Reflector Cluster-ID.
<base_URI>/config/running/router/bgp/default-local-preference Specifies the local preference value. The value can range from 0 through 65535.
<base_URI>/config/running/router/bgp/distance/lcl-route-distance Specifies the local BGP4 and BGP4+ distance. The value can range from 1 through 255
<base_URI>/config/running/router/bgp/capability Displays capability configuration.
<base_URI>/config/running/router/bgp/capability/as4-enable Enables 4-byte autonomous system number (ASN) capability.
<base_URI>/config/running/router/bgp/maxas-limit/in/num-as-in-path Configures the number of autonomous systems in the AS-PATH attribute.
<base_URI>/config/running/router/bgp/enforce-first-as Enforces the use of the first autonomous system (AS) path for external BGP (EBGP) routes.
<base_URI>/config/running/router/bgp/fast-external-fallover Resets the session if a link to an EBGP peer goes down.
<base_URI>/config/running/router/bgp/timers Diplsplays timers information.
<base_URI>/config/running/router/bgp/timers/hold-time Displays the interval in seconds that a device waits to receive a keepalive message from a peer before declaring that peer dead.
<base_URI>/config/running/router/bgp/log-dampening-debug Logs dampening debug messages.
<base_URI>/config/running/router/bgp/confederation Displays confederation information.
<base_URI>/config/running/router/bgp/confederation/identifier Specifies an autonomous system number (ASN).
<base_URI>/config/running/router/bgp/confederation/peers Displays the autonomous system (AS) numbers for BGP peers that will belong to the confederation.
<base_URI>/config/running/router/bgp/neighbor Displays neighbor router.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp Displays neighbor peer group.
<base_URI>/config/running/router/bgp/neighbor/peer-grps/neighbor-peer-grp/address Displays neighbor address.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name}/shutdown Displays peer group shutdown status.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/ospf Displays OSPF redistribution status.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/isis Dipslays IS-IS redistribution status.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/connected Displays unicast connected mode configuration.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/static Displays unicast static mode configuration.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/ospf Displays OSPF redistribution status.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/connected Displays connected redistribution.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/static Displays static redistribution.
POST URIs Payload Description
<base_URI>/config/running/router <bgp></bgp> Enters router BGP configuration mode.
<base_URI>/config/running/router/bgp <local-as>{unit32}</local-as> Configures Local AS.
<base_URL>/config/running/router/bgp/peer-group <ipv6prefix-over-ipv4peer> Enables the exchange of IPv6 routes with BGP neighbors over IPv4 session. This configuration only applies to BGP neighbors that are members of a peer-group.
<base_URI>/config/running/router/bgp/neighbor <neighbor-peer-grp><address>{string}</address><peer-group>{enumeration}</peer-group></neighbor-peer-grp> Configures neighbor peer group.
<base_URI>/config/running/router/bgp/neighbor <neighbor-peer-grp><address>{string}</address><peer-group>true</peer-group><remote-as>{unit32}</remote-as></neighbor-peer-grp> Configures Remote AS for neighbor peer group.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name} <remote-as>{unit32}</remote-as> Configures Remote AS.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name}/update-source <sip-ipv4-address>{ipv4-address}</sip-ipv4-address> Configures the update source IPv4 address for the neighbor BGP peer.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name}/update-source <sip-ipv6-address>{ipv6-address}</sip-ipv6-address> Configures the update source IPv6 address for the neighbor BGP peer.
<base_URI>/config/running/router/bgp/neighbor <neighbor-addr><address>{ip-address}</address><remote-as>{unit32}</remote-as><peer-group>{group-name}</peer-group></neighbor-addr> Configures neighbor address, remote AS, and peer group.
<base_URI>/config/running/router/bgp/neighbor <neighbor-addr><address>{ip-address}</address><remote-as>{unit32}</remote-as></neighbor-addr> Configures neighbor address and remote AS.
<base_URI>/config/running/router/bgp/neighbor/neighbor-addr/{ip-address} <peer-group>{group-name}</peer-group> Configures peer group.
<base_URI>/config/running/router/bgp/neighbor/neighbor-addr/{ip-address}/next-hop-self <next-hop-self-status>{enumeration}</next-hop-self-status> Configures next hop self status.
<base_URI>/config/running/router/bgp/neighbor/neighbor-addr/{ip-address}/ebgp-multihop <ebgp-multihop-count>{unit32}</ebgp-multihop-count> Configures EBGP multi-hop count.
<base_URI>/config/running/router/bgp/neighbor/neighbor-addr/{ip-address}/update-source <loopback>{unit32}</loopback> Configures loopback.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/ospf <redistribute-ospf>{enumeration}</redistribute-ospf> Configures OSPF redistribution.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute <isis></isis> Configures ISIS redistribution.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/static <redistribute-static>{enumeration}</redistribute-static> Configures static redistribution.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/connected <redistribute-connected>{enumeration}</redistribute-connected> Configures connected redistribution.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast <vrf><vrf-name>{string}</vrf-name></vrf> Configures VRF for address-family unicast.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/neighbor <af-ipv4-neighbor-addr><address>{ip-address}</address><remote-as>{unit32}</remote-as><peer-group>{group-name}</peer-group></af-ipv4-neighbor-addr> Configures neighbor.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/neighbor/af-ipv4-neighbor-addr/{ip-address}/update-source <loopback>{unit32}</loopback> Configures loopback.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/neighbor/af-ipv4-neighbor-addr/{ip-address}/next-hop-self <next-hop-self-status>{enumeration}</next-hop-self-status> Configures next hop self status.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/neighbor/af-ipv4-neighbor-addr/{ip-address}/ebgp-multihop <ebgp-multihop-count>{unit32}</ebgp-multihop-count> Configures EBGP multi-hop count.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/ospf <redistribute-ospf>{enumeration}</redistribute-ospf> Configures OSPF redistribution.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/connected <redistribute-connected>{enumeration}</redistribute-connected> Configures connected redistribution.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/static <redistribute-static>{enumeration}</redistribute-static> Configures static redistribution.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name} <description>{string}</description> Configures description.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast <network><network-ipv4-address>{ip-address/mask}</network-ipv4-address></network> Configures IPv4 unicast address family.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast <network><network-ipv4-address>{ip-address/mask}</network-ipv4-address><weight>{unit32}</weight></network> Configures network weight.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name}/shutdown <shutdown-status>{enumeration}</shutdown-status> Shuts down the peer group.
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/neighbor/af-ipv4-neighbor-address/{ip-address}/route-map/in <neighbor-route-map-name-direction-in>{string}</neighbor-route-map-name-direction-in> Configures route map direction.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor <af-ipv6u-ipv4-neighbor><address>{ipv4addr}</address><activate/></af-ipv6u-ipv4-neighbor> Configures exchanging IPv6 routes over IPv4 session with BGP peer using the default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths <disable/> Disables the inheritance of additional-paths capability from a specific bgp peer using default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths <send/> Enables the device to send additional-paths for a specific peer in a BGP address family in default-vrf. Enables sending additional-path for a specific peer using default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths <receive/> Enables receiving additional-paths for a specific peer in a BGP address family in default-vrf
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths/advertise <best>{uint8}</best> Specifies the number of best paths allowed for selection as additional paths for a specific BGP peer session in default-vrf. The range is 2-16 best paths.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths/advertise <all/> Enables all routes to be eligible for selection as additional paths for a specific BGP peer session in default-vrf. A maximum of 16 routes are allowed.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths/advertise <group-best/> Enables all group-best paths to be considered for selection as additional-paths for a specific BGP peer session in the default-vrf. Only routes with a rank less than or equal to 16 are allowed.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr} <allowas-in>{uint32}</allowas-in> Disables the AS_PATH check function for routes learned from a specified peer in default-vrf so that BGP does not reject routes that contain the recipient BGP peer's AS number.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/capability/orf/prefixlist <prefixlist-status/> Advertises outbound route filter (ORF) capabilities to peer routers in default-vrf. Configuring both send and receive will enable both ORF.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr{/default-originate <default-originate-status/> Configures the device to send the default route ::/0 to a BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/default-originate <route-map>{string}</route-map> Specifies the route-map to be applied for default-originated routes to a BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr} <enable-peer-as-check/> Enables the outbound AS_PATH check function to ensure that a BGP sender does not send routes with an AS path that contains the ASN of the receiving BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/filter-list <filter-list-direction-in-acl-name>{string}</filter-list-direction-in-acl-name> Specifies a filter list to be applied to incoming routes from the specified BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/filter-list <filter-list-direction-out-acl-name>{string}</filter-list-direction-out-acl-name> Specifies a filter list to be applied to outgoing routes to the specified BGP peer in default-vrf.
<base_URI>config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/maximum-prefix <max-prefix-limit>{uint32}</max-prefix-limit> Specifies the maximum number of IP network prefixes (routes) that can be learned from a specified BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/prefix-list <prefix-list-direction-in-prefix-name>{string}</prefix-list-direction-in-prefix-name> Filters the incoming route updates from a particular BGP peer in default-vrf according to IP address and mask length defined in prefix-list.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/prefix-list <prefix-list-direction-out-prefix-name>{string}</prefix-list-direction-out-prefix-name> Filters the outgoing route updates to a particular BGP peer in default-vrf according to IP address and mask length defined in the prefix-list.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/route-map/in <neighbor-route-map-name-direction-in>{string}</neighbor-route-map-name-direction-in> Filters the incoming route updates from a particular BGP peer in default-vrf according to attributes defined in a route map.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/route-map/out <neighbor-route-map-name-direction-out>{string}</neighbor-route-map-name-direction-out> Filters the outgoing route updates to a particular BGP peer in default-vrf according to attributes defined in a route map.
<base_URI>/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr} <route-reflector-client/> Configures a peer in default-vrf as a route-reflector client.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/send-community <all/> Enables sending all the community attribute in updates to the specified BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/send-community <standard/> Enables sending standard community attribute in updates to the specified BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/send-community <extended/> Enables sending extended community attribute in updates to the specified BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/send-community <large/> Enables sending large community attribute in updates to the specified BGP peer in default-vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/unsuppress-map <map-name>{string}</map-name> Removes route suppression from BGP peer routes when those routes have been suppressed because of aggregation. All routes matching route-map rules are unsuppressed.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr} <weight>{uint32}</weight> Specifies a weight that the device will add to routes that are received from the specified BGP peer in default-vrf
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor <af-ipv6u-ipv4-neighbor><address>{ipv4addr}</address><activate/></af-ipv6u-ipv4-neighbor> Allows the device to exchange IPv6 routes with BGP peer over IPv4 session in user-defined vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths <disable/> Disables inheritance of additional-paths capability from the address family for a specific peer in a BGP address family in user-defined vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths <send/> Enables device to send additional-paths for a specific peer in a BGP address family in user-defined vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths <receive/> Enables device to receive additional-paths for a specific peer in a BGP address family in user-defined vrf
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths/advertise <best>{uint8}</best> Specifies the number of best paths allowed for selection as additional paths for a specific BGP peer session in user-defined vrf . The number ranges from 2 through 16 .
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths/advertise <all/> Enables all routes to be eligible for selection as additional paths for a specific BGP peer session in user-defined vrf. A maximum of 16 routes are allowed.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/additional-paths/advertise <group-best/>, Causes all group-best paths to be eligible for selection as additional-paths for a specific BGP peer session in user-defined vrf. Only routes with a rank less than or equal to 16 are allowed. Even when it is the group-best, a route with a rank greater than 16 is not eligible for selection as an additional path.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr} <allowas-in>{uint32}</allowas-in> Disables the AS_PATH check function for routes learned from a specified neighbor in user-defined vrf so that BGP peer does not reject routes that contain the recipient BGP peer's AS number
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/capability/orf/prefixlist <prefixlist-status/> Advertises outbound route filter (ORF) capabilities to peer routers in user-defined vrf. Configuring both send and receive will enable both ORFs.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr{/default-originate <default-originate-status/> Configures the device to send the default route ::/0 to a BGP peer in user-defined vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/default-originate <route-map>{string}</route-map> Specifies the route-map to be applied for default-originated routes to a BGP peer in user-defined vrf .
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr} <enable-peer-as-check/> Enables the outbound AS_PATH check function so that a BGP peer does not send routes with an AS path that contains the ASN of the receiving BGP peer in user-defined vrf .
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/filter-list <filter-list-direction-in-acl-name>{string}</filter-list-direction-in-acl-name> Specifies a filter list to be applied to incoming routes from the specified BGP peer in user-defined vrf.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/neighbor/vrf/{vrf-name}/af-ipv6u-ipv4-neighbor/{ipv4addr}/filter-list <filter-list-direction-out-acl-name>{string}</filter-list-direction-out-acl-name> Specifies a filter list to be applied to outgoing routes to the specified BGP peer in user-defined vrf .
<base_URI>config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/maximum-prefix <max-prefix-limit>{uint32}</max-prefix-limit> Specifies the maximum number of IP network prefixes (routes) that can be learned from a specified BGP peer in user-defined vrf .
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/prefix-list <prefix-list-direction-in-prefix-name>{string}</prefix-list-direction-in-prefix-name> Filters the incoming route updates from a particular BGP peer in user-defined vrf according to IP address and mask length defined in the prefix-list.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/prefix-list <prefix-list-direction-out-prefix-name>{string}</prefix-list-direction-out-prefix-name> Filters the outgoing route updates to a particular BGP peer in the user-defined vrf according to IP address and mask length defined in the prefix-list.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/route-map/in <neighbor-route-map-name-direction-in>{string}</neighbor-route-map-name-direction-in> Filters the incoming route updates a particular BGP peer in the user-defined vrf according to attributes defined in a route map.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/route-map/out <neighbor-route-map-name-direction-out>{string}</neighbor-route-map-name-direction-out> Filters the outgoing route updates to a particular BGP peer in the user-defined vrf according to attributes defined in a route map.
<base_URI>/rest/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr} <route-reflector-client/> Configures a BGP peer in the user-defined vrf as a route-reflector client.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/send-community <all/> Enables sending all the community attribute in updates to the specified BGP peer in the user-defined vrf .
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/send-community <standard/> Enables sending standard community attribute in updates to the specified BGP peer in the user-defined vrf .
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/send-community <extended/> Enables sending extended community attribute in updates to the specified BGP peer in the user-defined vrf .
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/send-community <large/> Enables sending large community attribute in updates to the specified BGP peer in the user-defined vrf .
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr}/unsuppress-map <map-name>{string}</map-name> Removes route suppression from BGP peer routes when those routes have been suppressed because of aggregation. All routes matching route-map rules are unsuppressed.
<base_URI>/config/running/router/bgp/address-family/ipv6/unicast/vrf/{vrf-name}/neighbor/af-ipv6u-ipv4-neighbor/{ipv4addr} <weight>{uint32}</weight> Specifies a weight that the device will add to routes that are received from the specified BGP peer in the user-defined vrf .
PATCH URIs Payload Description
<base_URI>/config/running/router/bgp <bgp></bgp> Configures Router BGP.
<base_URI>/config/running/router/bgp/local-as <local-as>{unit32}</local-as> Configures local AS.
<base_URI>/config/running/router/bgp/local-as <bgp><local-as>{unit32}</local-as></bgp> Configures local AS.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp <neighbor-peer-grp><address>{group-name}</address><peer-group>{enumeration}</peer-group></neighbor-peer-grp> Configures peer group.
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name} <peerGroup1><remote-as>{enumeration}</remote-as></peerGroup1> Configures peer group Remote AS.
PUT URIs Payload Description
<base_URI>/config/running/router/bgp <bgp></bgp> Configures Router BGP.
<base_URI>/config/running/router/bgp/local-as <local-as>{unit32}</local-as> Configures local AS.
<base_URI/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name}/remote-as <remote-as>{unit32}</remote-as> Configures remote AS.
DELETE URIs
<base_URI>/config/running/router/bgp
<base_URI>/config/running/router/bgp/local-as
<base_URI>/config/running/router/bgp/neighbor
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name}/update-source/sip-ipv4-address
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name}/update-source/sip-ipv6-address
<base_URI>/config/running/router/bgp/neighbor/peer-grps/neighbor-peer-grp/address
<base_URI>/config/running/router/bgp/neighbor/neighbor-peer-grp/{group-name}/shutdown
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/network/{ip-address}
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/network/{ip-address}
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/network
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/ospf
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/isis
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/connected
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/redistribute/static
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/ospf
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/connected
<base_URI>/config/running/router/bgp/address-family/ipv4/unicast/vrf/{vrf-name}/redistribute/static

Parameters

local-as
Specifies the local ASN. The value can range from 1 through 4294967295.
always-compare-med
Enables the device to always compare the Multi-Exit Discriminators {MEDs}.
compare-med-empty-aspath
Enables comparison of Multi-Exit Discriminators {MEDs} for internal routes.
med-missing-as-worst
Considers routes missing MED attributes as least desirable.
as-path-ignore
Disables the comparison of the autonomous system {AS} path lengths of otherwise equal paths.
compare-routerid
Enables comparison of device IDs.
install-igp-cost
Enables the device to use the IGP cost instead of the default BGP4 or BGP4+ Multi-Exit Discriminator {MED} value.
id
Configures Route-Reflector Cluster-ID.
default-local-preference
Specifies the local preference value. The value can range from 0 through 65535.
ext-route-distance
Specifies the EBGP distance. The value can range from 1 through 255.
int-route-distance
Specifies the IBGP distance. The value can range from 1 through 255.
lcl-route-distance
Specifies the local BGP4 and BGP4+ distance. The value can range from 1 through 255.
as4-enable
Enables 4-byte autonomous system number {ASN} capability.
ebgp-btsh
Enables BGP time to live {TTL} security hack protection {BTSH} for eBGP.
num-as-in-path
Configures the number of autonomous systems in the AS-PATH attribute.
enforce-first-as
Enforces the use of the first autonomous system {AS} path for external BGP {EBGP} routes.
fast-external-fallover
Resets the session if a link to an EBGP peer goes down.
keep-alive
Specifies the frequency in seconds with which a device sends keepalive messages to a peer. The value can range from 0 through 65535 seconds. The default value is 60 seconds.
hold-time
Specifies the interval in seconds that a device waits to receive a keepalive message from a peer before declaring that peer dead. The value can range from 0 through 65535 seconds. The default value is 180 seconds.
log-dampening-debug
Logs dampening debug messages.
identifier
Specifies an autonomous system number {ASN}. The value can range from 1 through 4294967295.
peers
Specifies the autonomous system {AS} numbers for BGP peers that will belong to the confederation. The value can range from 1 through 4294967295.
address
Configures neighbor address.
bgp-redistribute-internal
Enables BGP4 route redistribution.
redistribute-connected
Redistributes directly connected routes.
metric
Configures metric for redistributed routes.
redistribute-ospf
Enables Open Shortest Path First {OSPF}.
redistribute-static
Enables Static routes.
ebgp
Specifies the number of EBGP paths. The value can range from 1 through 32. The default value is all.
Ibgp
Specifies the number of IBGP paths for load sharing. The value can range from 1 through 32. The default value is all.
use-load-sharing
Uses the maximum IP ECMP path value.
always-propagate
Configures the device to reflect BGP routes that are not installed in the RTM.
default-information-originate
Sets the device to originate and advertise a default BGP4 or BGP4+ route.
activate
Allows exchange of route in the current family mode.
enable-peer-as-check
Disables routes advertise between peers in same AS.
rib-route-limit
Configures limit BGP rib count in routing table.
half-time
Specifies the number of minutes after which the route penalty becomes half its value. The value can range from 1 through 45 minutes. The default time is 15 minutes.
reuse-value
Specifies the minimum penalty below which the route becomes usable again. The value can range from 1 through 20000. The default value is 750.
start-suppress-time
Specifies the maximum penalty above which the route is suppressed by the device. The value can range from 1 through 20000. The default value is 2000.
max-suppress-time
Specifies the maximum number of minutes a route can be suppressed by the device. The default value is 40.
default-metric
Specifies the metric value. The value can range from 0 through 4294967295. The default value is 1.
update-time
Configures IGP route update interval.
metric
Configures metric for redistributed routes.
route-map
Route map reference.
bgp-redistribute-internal
Allows redistribution of IBGP routes into IGPs.
route-map
Specifies the route map name.
aggregate-ip-prefix
Specifies the IPv4 address.
network-ipv6-address
Specifies the IPv6 address.
advertise-map
Specifies a route map to be consulted.
as-set
Sets the device to aggregate AS-path information.
attribute-map
Specifies a route map to be consulted.
summary-only
Prevents the device from advertising more-specific routes contained within the aggregate route.
suppress-map
Specifies a route map to be consulted.
ibgp
Configures the IBGP distance.
multi-as
Enables load sharing of paths from different neighboring autonomous systems.
network-ipv4-address
Configures the IP address.
weight
Configures the weight to be added to routes in this network.
backdoor
Changes administrative distance of the route to this network from the EBGP administrative distance.
allowas-in
Disables the AS_PATH check function for routes learned from a specified neighbor location so that BGP does not reject routes that contain the recipient BGP speaker's AS number.
static-network-address
Configures the static network address.
auto-shutdown-new-neighbors
Automatically shuts down new neighbors.
activate
Allows exchange of routes in the current family mode.
additional-paths
Enables the advertisement of additional paths for BGP neighbors. Possible configurations are:
ipv6prefix-over-ipv4peer
This enables the exchanging of IPv6 addresses over IPv4 BGP sessions. This configuration only applies to those BGP neighbors who are members of a peer group.
receive
Enables the BGP to receive additional paths from BGP neighbors.
send
Enable the BGP to send additional paths to BGP neighbors.
advertise
Applies filters for the advertisement of additional paths for BGP neighbors. Possible configurations are:
all
Advertises all BGP additional paths with a unique next hop.
best
Advertises the additional paths that the device selects as best paths. You can specify the number of best paths advertised. The value can range from 1 through 5.
all
Configures a route reflector {RR} to accept all route targets {RTs}.
route-reflector-client
Enables a neighbor to be a route-reflector client.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/router/bgp

None 

<bgp xmlns="urn:brocade.com:mgmt:brocade-bgp" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/bgp/default">
  <local-as>124</local-as>
  <always-compare-med>true</always-compare-med>
  <compare-med-empty-aspath>true</compare-med-empty-aspath>
  <med-missing-as-worst>true</med-missing-as-worst>
  <as-path-ignore>true</as-path-ignore>
  <compare-routerid>true</compare-routerid>
  <install-igp-cost>true</install-igp-cost>
  <cluster-id y:self="/rest/config/running/router/bgp/default/cluster-id">
    <id>122</id>
  </cluster-id>
  <default-local-preference>100</default-local-preference>
  <distance y:self="/rest/config/running/router/bgp/default/distance">
    <ext-route-distance>20</ext-route-distance>
    <int-route-distance>25</int-route-distance>
    <lcl-route-distance>22</lcl-route-distance>
  </distance>
  <capability y:self="/rest/config/running/router/bgp/default/capability">
    <as4-enable>true</as4-enable>
  </capability>
  <maxas-limit y:self="/rest/config/running/router/bgp/default/maxas-limit">
    <in y:self="/rest/config/running/router/bgp/default/maxas-limit/in">
      <num-as-in-path>250</num-as-in-path>
    </in>
  </maxas-limit>
  <enforce-first-as>true</enforce-first-as>
  <fast-external-fallover>true</fast-external-fallover>
  <timers y:self="/rest/config/running/router/bgp/default/timers">
    <keep-alive>65</keep-alive>
    <hold-time>170</hold-time>
  </timers>
  <log-dampening-debug>true</log-dampening-debug>
  <auto-shutdown-new-neighbors>true</auto-shutdown-new-neighbors>
  <confederation y:self="/rest/config/running/router/bgp/default/confederation">
    <identifier>20000</identifier>
    <peers>100 120 130 140 1200 2300 5600 40000</peers>
  </confederation>
  <bfd xmlns="urn:brocade.com:mgmt:brocade-bgp" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/bgp/bfd">
    <holdover-interval>10</holdover-interval>
    <interval xmlns="urn:brocade.com:mgmt:brocade-bfd" y:self="/rest/config/running/router/bgp/bfd/interval">
      <min-tx>75</min-tx>
      <min-rx>80</min-rx>
      <multiplier>3</multiplier>
    </interval>
  </bfd>
  <neighbor y:self="/rest/config/running/router/bgp/default/neighbor/INTERNAL">
    <address>INTERNAL</address>
  </neighbor>
  <neighbor y:self="/rest/config/running/router/bgp/default/neighbor/PeerGroup1">
    <address>PeerGroup1</address>
  </neighbor>
  <neighbor xmlns="urn:brocade.com:mgmt:brocade-bgp" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/bgp/neighbor">
    <neighbor-peer-grp y:self="/rest/config/running/router/bgp/neighbor/neighbor-peer-grp/peer1">
      <address>peer1</address>
      <bfd y:self="/rest/config/running/router/bgp/neighbor/neighbor-peer-grp/peer1/bfd">
        <holdover-interval>10</holdover-interval>
        <interval xmlns="urn:brocade.com:mgmt:brocade-bfd" y:self="/rest/config/running/router/bgp/neighbor/
neighbor-peer-grp/peer1/bfd/interval">
          <min-tx>70</min-tx>
          <min-rx>60</min-rx>
          <multiplier>10</multiplier>
        </interval>
      </bfd>
    </neighbor-peer-grp>
    <neighbor-ipv6-addr y:self="/rest/config/running/router/bgp/neighbor/neighbor-ipv6-addr/2004:384d::21:22">
      <address>2004:384d::21:22</address>
      <bfd y:self="/rest/config/running/router/bgp/neighbor/neighbor-ipv6-addr/2004:384d::21:22/bfd">
        <holdover-interval>25</holdover-interval>
        <interval xmlns="urn:brocade.com:mgmt:brocade-bfd" y:self="/rest/config/running/router/bgp/neighbor/
neighbor-ipv6-addr/2004:384d::21:22/bfd/interval">
          <min-tx>60</min-tx>
          <min-rx>60</min-rx>
          <multiplier>40</multiplier>
        </interval>
      </bfd>
    </neighbor-ipv6-addr>
    <neighbor-addr xmlns="urn:brocade.com:mgmt:brocade-bgp" y:self="/rest/config/running/router/bgp/neighbor/
neighbor-addr/1.1.1.1">
      <address>1.1.1.1</address>
      <ebgp-btsh></ebgp-btsh>
      <bfd y:self="/rest/config/running/router/bgp/neighbor/neighbor-addr/1.1.1.1/bfd">
        <holdover-interval>20</holdover-interval>
        <interval xmlns="urn:brocade.com:mgmt:brocade-bfd" y:self="/rest/config/running/router/bgp/neighbor/
neighbor-addr/1.1.1.1/bfd/interval">
          <min-tx>5000</min-tx>
          <min-rx>3000</min-rx>
          <multiplier>4</multiplier>
        </interval>
      </bfd>
    </neighbor-addr>
  </neighbor>
  <neighbor y:self="/rest/config/running/router/bgp/default/neighbor/VCS_8192">
    <address>VCS_8192</address>
  </neighbor>
  <address-family y:self="/rest/config/running/router/bgp/default/address-family">
    <ipv4 y:self="/rest/config/running/router/bgp/default/address-family/ipv4">
      <unicast y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast">
        <bgp-redistribute-internal>true</bgp-redistribute-internal>
        <redistribute y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/redistribute">
          <connected y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/redistribute/connected">
            <redistribute-connected>true</redistribute-connected>
            <metric>23</metric>
            <route-map>route1</route-map>
          </connected>
          <ospf y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/redistribute/ospf">
            <redistribute-ospf>true</redistribute-ospf>
            <match y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/redistribute/ospf/match"/>
            <metric>26</metric>
          </ospf>
          <static y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/redistribute/static">
            <redistribute-static>true</redistribute-static>
            <metric>30</metric>
            <route-map>route1</route-map>
          </static>
        </redistribute>
        <aggregate-address y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/
aggregate-address/%2210.11.12.0/24%22">
          <aggregate-ip-prefix>10.11.12.0/24</aggregate-ip-prefix>
          <advertise-map>map2</advertise-map>
          <as-set>true</as-set>
          <attribute-map>map2</attribute-map>
          <summary-only>true</summary-only>
          <suppress-map>map1</suppress-map>
        </aggregate-address>
        <neighbor y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/neighbor/INTERNAL">
          <address>INTERNAL</address>
        </neighbor>
        <neighbor y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/neighbor/10.11.132.7">
          <address>10.11.132.7</address>
        </neighbor>
        <neighbor xmlns="urn:brocade.com:mgmt:brocade-bgp" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/neighbor">
          <af-ipv4-neighbor-address y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/neighbor/
af-ipv4-neighbor-address/1.1.1.1">
            <address>1.1.1.1</address>
            <activate>true</activate>
          <af-ipv4-neighbor-address>
        </neighbor>
        <neighbor xmlns="urn:brocade.com:mgmt:brocade-bgp" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/neighbor">
          <af-ipv4-neighbor-address xmlns="urn:brocade.com:mgmt:brocade-bgp" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/neighbor/af-ipv4-neighbor-address/10.10.10.1">
            <address>10.10.10.1</address>
             <route-reflector-client>true</route-reflector-client>
              <additional-paths y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/neighbor/
af-ipv4-neighbor-address/10.10.10.1/additional-paths">
                <advertise y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/neighbor/
af-ipv4-neighbor-address/10.10.10.1/additional-paths/advertise">
                  <best>1</best>
                </advertise>
              </additional-paths>
            <capability y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/neighbor/
af-ipv4-neighbor-address/10.10.10.1/capability">
              <additional-paths y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/
neighbor/af-ipv4-neighbor-address/10.10.10.1/capability/additional-paths">
                <add-path-both>true</add-path-both>
                <receive>true</receive>
              </additional-paths>
            </capability>
          </af-ipv4-neighbor-address>
        </neighbor>
        <network y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/network/%2210.11.12.0/24%22">
          <network-ipv4-address>10.11.12.0/24</network-ipv4-address>
          <weight>100</weight>
          <backdoor>true</backdoor>
          <route-map>map1</route-map>
        </network>
        <static-network y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/static-network/
%2210.10.12.0/24%22">
          <static-network-address>10.10.12.0/24</static-network-address>
          <distance>10</distance>
        </static-network>
        <maximum-paths y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/maximum-paths">
          <ebgp>2</ebgp>
          <ibgp>3</ibgp>
          <use-load-sharing>true</use-load-sharing>
        </maximum-paths>
        <multipath y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/multipath">
          <ibgp>true</ibgp>
          <multi-as>true</multi-as>
        </multipath>
        <always-propagate>true</always-propagate>
        <default-information-originate>true</default-information-originate>
        <rib-route-limit>2000</rib-route-limit>
        <dampening y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/dampening">
          <half-time>20</half-time>
          <reuse-value>755</reuse-value>
          <start-suppress-time>2100</start-suppress-time>
          <max-suppress-time>45</max-suppress-time>
        </dampening>
        <default-metric>1</default-metric>
        <table-map y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/table-map"/>
        <update-time>10</update-time>
        <graceful-restart y:self="/rest/config/running/router/bgp/default/address-family/ipv4/unicast/graceful-restart">
          <restart-time>250</restart-time>
          <purge-time>200</purge-time>
          <stale-routes-time>300</stale-routes-time>
        </graceful-restart>
        <vrf y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/vrf/red">
          <vrf-name>red</vrf-name>
          <redistribute y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/vrf/red/redistribute">
            <bgp y:self="/rest/config/running/router/bgp/address-family/ipv4/unicast/vrf/red/redistribute/bgp">
              <metric>250</metric>
              <route-map>map1</route-map>
            </bgp>
          </redistribute>
        </vrf>
      </unicast>
    </ipv4>
    <ipv6 y:self="/rest/config/running/router/bgp/default/address-family/ipv6">
      <unicast y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast">
        <bgp-redistribute-internal>true</bgp-redistribute-internal>
        <redistribute y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/redistribute">
          <connected y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/redistribute/connected">
            <redistribute-connected>true</redistribute-connected>
            <metric>23</metric>
          </connected>
          <ospf y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/redistribute/ospf">
            <redistribute-ospf>true</redistribute-ospf>
            <match y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/redistribute/ospf/match"/>
            <metric>34</metric>
          </ospf>
          <static y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/redistribute/static">
            <redistribute-static>true</redistribute-static>
            <metric>45</metric>
            <route-map>redist107_1</route-map>
          </static>
        </redistribute>
        <aggregate-address y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/aggregate-address/
%22fd80:122:122:122::/64%22">
          <aggregate-ip-prefix>fd80:122:122:122::/64</aggregate-ip-prefix>
        </aggregate-address>
        <network y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/network/%22131::1/128%22">
          <network-ipv6-address>131::1/128</network-ipv6-address>
        </network>
        <network y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/network/
%22fd80:122:122:122:105:105:0:122/128%22">           <network-ipv6-address>fd80:122:122:122:105:105:0:122/128
</network-ipv6-address>
        </network>
        <neighbor y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/neighbor/vcs_2122">
          <address>vcs_2122</address>
        </neighbor>
        <neighbor y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/neighbor/VCS_8192_rr">
          <address>VCS_8192_rr</address>
        </neighbor>
        <neighbor y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/neighbor/fd80:2001:2040::40">
          <address>fd80:2001:2040::40</address>
        </neighbor>
        <neighbor xmlns="urn:brocade.com:mgmt:brocade-bgp" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor">
          <af-ipv6-neighbor-address y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124">
            <address>2001:2018:8192::124</address>
            <send-community y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/send-community">
            </send-community>
            <capability y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/capability">
              <orf y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/af-ipv6-neighbor-address/
2001:2018:8192::124/capability/orf">
                <prefixlist y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/capability/orf/prefixlist">
                </prefixlist>
              </orf>
              <additional-paths y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/capability/additional-paths">
              </additional-paths>
            </capability>
            <additional-paths y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/additional-paths">
              <advertise y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/additional-paths/advertise">
              </advertise>
            </additional-paths>
            <activate>true</activate>
            <allowas-in>3</allowas-in>
            <enable-peer-as-check>true</enable-peer-as-check>
            <filter-list y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/filter-list">
            </filter-list>
            <maximum-prefix y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/maximum-prefix">
            </maximum-prefix>
            <default-originate y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/default-originate">
            </default-originate>
            <prefix-list y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/prefix-list">
            </prefix-list>
            <route-map y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/route-map">
              <in y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/route-map/in">
              </in>
              <out y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/route-map/out">
              </out>
            </route-map>
            <unsuppress-map y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/neighbor/
af-ipv6-neighbor-address/2001:2018:8192::124/unsuppress-map">
           </unsuppress-map>
          </af-ipv6-neighbor-address>
        </neighbor>
        <maximum-paths y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/maximum-paths">
          <ebgp>2</ebgp>
          <ibgp>2</ibgp>
          <use-load-sharing>true</use-load-sharing>
        </maximum-paths>
        <multipath y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/multipath"/>
        <always-propagate>true</always-propagate>
        <default-information-originate>true</default-information-originate>
        <rib-route-limit>1000</rib-route-limit>
        <dampening y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/dampening">
          <half-time>30</half-time>
          <reuse-value>1100</reuse-value>
          <start-suppress-time>2100</start-suppress-time>
          <max-suppress-time>45</max-suppress-time>
        </dampening>
        <default-metric>2</default-metric>
        <table-map y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/table-map"/>
        <update-time>10</update-time>
        <graceful-restart y:self="/rest/config/running/router/bgp/default/address-family/ipv6/unicast/graceful-restart">
          <restart-time>1400</restart-time>
          <purge-time>1200</purge-time>
          <stale-routes-time>1600</stale-routes-time>
        </graceful-restart>
        <vrf y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/vrf/vrf1">
          <vrf-name>vrf1</vrf-name>
          <redistribute y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/vrf/vrf1/redistribute">
            <bgp y:self="/rest/config/running/router/bgp/address-family/ipv6/unicast/vrf/vrf1/redistribute/bgp">
              <metric>500</metric>
              <route-map>map2</route-map>
            </bgp>
          </redistribute>
        </vrf>
      </unicast>
    </ipv6>
  </address-family>
</bgp>

URI

The following is an example of the POST operation to configure BGP neighbor.

http://host:80/rest/config/running/router/bgp/neighbor 

<neighbor-peer-grp>
  <address>peerGroup1</address>
  <peer-group>true</peer-group>
</neighbor-peer-grp>

None

URI

The following is an example of the DELETE to remove router BGP configuration.

http://host:80/rest/config/running/router/bgp

None

None

9038050-00 Rev AA