BGP/BGP4+
此内容尚不支持你的语言。
Border Gateway Protocol.
| URL | GET | POST | PATCH | PUT | DELETE |
|---|---|---|---|---|---|
| /rest/v1/running/as-path-access-lists/{name}/{sequence-number} | Y | Y | N | Y | Y |
| /rest/v1/running/bgp/{vrf-name} | Y | Y | Y | N | Y |
| /rest/v1/running/bgp/{vrf-name}/global | Y | N | Y | N | N |
| /rest/v1/running/bgp/{vrf-name}/global/ipv4-unicast/aggregate-route/{prefix} | Y | Y | Y | N | Y |
| /rest/v1/running/bgp/{vrf-name}/global/ipv4-unicast/networks/{prefix} | Y | Y | Y | N | Y |
| /rest/v1/running/bgp/{vrf-name}/global/ipv4-unicast/redistribution/{route-type} | Y | Y | Y | N | Y |
| /rest/v1/running/bgp/{vrf-name}/global/ipv6-unicast/aggregate-route/{prefix} | Y | Y | Y | N | Y |
| /rest/v1/running/bgp/{vrf-name}/global/ipv6-unicast/networks/{prefix} | Y | Y | Y | N | Y |
| /rest/v1/running/bgp/{vrf-name}/global/ipv6-unicast/redistribution/{route-type} | Y | Y | Y | N | Y |
| /rest/v1/running/bgp/{vrf-name}/global/l2vpn-evpn | Y | N | Y | N | N |
| /rest/v1/running/bgp/{vrf-name}/neighbors/{address-or-interface} | Y | Y | Y | N | Y |
| /rest/v1/running/bgp/{vrf-name}/peer-groups/{name} | Y | Y | Y | N | Y |
| /rest/v1/running/community-aliases/{name} | Y | Y | Y | N | Y |
| /rest/v1/running/community-lists/{name}/{sequence-number} | Y | Y | N | Y | Y |
| /rest/v1/running/extended-community-lists/{name}/{sequence-number} | Y | Y | N | Y | Y |
| /rest/v1/running/extended-numbered-community-lists/{list-number}/{sequence-number} | Y | Y | N | Y | Y |
| /rest/v1/running/numbered-community-lists/{list-number}/{sequence-number} | Y | Y | N | Y | Y |
| /rest/v1/rpc/show-bgp-community-list | N | Y | N | N | N |
| /rest/v1/rpc/show-bgp-l2vpn-evpn | N | Y | N | N | N |
| /rest/v1/rpc/show-bgp-neighbors | N | Y | N | N | N |
| /rest/v1/rpc/show-bgp-peer-group | N | Y | N | N | N |
| /rest/v1/rpc/show-bgp-statistics | N | Y | N | N | N |
| /rest/v1/rpc/show-bgp-summary | N | Y | N | N | N |
| /rest/v1/rpc/show-bgp-vrf-all | N | Y | N | N | N |
| /rest’/v1/rpc/show-evpn-vni | N | Y | N | N | N |
| /rest/v1/rpc/show-ip-bgp | N | Y | N | N | N |
Examples
Section titled “Examples”Show bgp community list
Section titled “Show bgp community list”POST HTTPS://{switch IP}/rest/v1/rpc/show-bgp-community-list{ "vrf": "Vrftest", "community-list": "comm_test"}Show bgp l2vpn evpn
Section titled “Show bgp l2vpn evpn”POST HTTPS://{switch IP}/rest/v1/rpc/show-bgp-l2vpn-evpn{ "vrf": "Vrftest"}Show bgp neighbors
Section titled “Show bgp neighbors”POST HTTPS://{switch IP}/rest/v1/rpc/show-bgp-neighbors{ "vrf": "Vrftest", "address": "10.0.0.1"}Show bgp peer group
Section titled “Show bgp peer group”POST HTTPS://{switch IP}/rest/v1/rpc/show-bgp-peer-group{ "address": "2000::1", "advertised-routes": null, "advertised-route-map": "rmap1"}Show bgp statistics
Section titled “Show bgp statistics”POST HTTPS://{switch IP}/rest/v1/rpc/show-bgp-statistics{ "vrf": "Vrftest"}Show bgp summary
Section titled “Show bgp summary”POST HTTPS://{switch IP}/rest/v1/rpc/show-bgp-summary{ "established": null}Show bgp vrf all
Section titled “Show bgp vrf all”POST HTTPS://{switch IP}/rest/v1/rpc/show-bgp-vrf-allShow evpn vni
Section titled “Show evpn vni”POST HTTPS://{switch IP}/rest/v1/rpc/show-evpn-vni{ "vni": 10010}Show ip bgp
Section titled “Show ip bgp”POST HTTPS://{switch IP}/rest/v1/rpc/show-ip-bgp{ "vrf": "Vrftest", "address": "10.0.0.1"}Get all BGP configurations
Section titled “Get all BGP configurations”GET HTTPS://{switch IP}/rest/v1/running/bgpModify BGP global configuration for a VRF
Section titled “Modify BGP global configuration for a VRF”PATCH HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/global{ "ipv4-unicast": { "networks": [{"prefix": "1.2.3.4/32"}], }, "ipv6-unicast": { "networks": [{"prefix": "2001:db8::/32"}], }, "l2vpn-evpn": { "advertise-all-vni": "false", }}Modify BGP global l2vpn EVPN configuration for a VRF
Section titled “Modify BGP global l2vpn EVPN configuration for a VRF”PATCH rest/v1/running/bgp/Vrf1/global/l2vpn-evpn{ "advertise-all-vni": "true"}Create an IPv4 aggregate route
Section titled “Create an IPv4 aggregate route”POST HTTPS://{switch IP}/rest/v1/running/bgp/{vrf-name}/global/ipv4-unicast/aggregate-route{ "prefix": "200.0.0.0/24"}Create an IPv4 network
Section titled “Create an IPv4 network”POST HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/global/ipv4-unicast/networks{ "prefix": "30.0.0.1/24", "backdoor": "true"}Create an IPv4 redistribution
Section titled “Create an IPv4 redistribution”POST HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/global/ipv4-unicast/redistribution{ "route-type": "static", "metric": 100}Create an IPv6 aggregate route
Section titled “Create an IPv6 aggregate route”POST HTTPS://{switch IP}/rest/v1/running/bgp/{vrf-name}/global/ipv6-unicast/aggregate-route{ "prefix": "2002::0/64"}Create an IPv6 network
Section titled “Create an IPv6 network”POST HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/global/ipv6-unicast/networks{ "prefix": "3AB::/24", "backdoor": "true"}Create an IPv6 redistribution
Section titled “Create an IPv6 redistribution”POST HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/global/ipv6-unicast/redistribution{ "route-type": "static", "metric": 100}Create a BGP neighbor
Section titled “Create a BGP neighbor”POST HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/neighbors{ "address-or-interface": "1.1.1.1", "remote-as": 65105, "ebgp-multihop": { "enabled": "true", "multihop-ttl": 255, }, "graceful-restart": "true", "ipv4-unicast": { "default-originate": "true", "default-originate-route-map": "rmap6", "next-hop-self": "false", }, "ipv6-unicast": { "enable": "true", }}Modify a BGP neighbor
Section titled “Modify a BGP neighbor”PATCH HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/neighbors/1.1.1.1{ "remote-as": 65106}Delete a BGP neighbor
Section titled “Delete a BGP neighbor”DELETE HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/neighbors/11.11.11.11Create a BGP peer group
Section titled “Create a BGP peer group”POST HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/peer-groups{ "name": "PG3", "solo": "true", "ebgp-multihop": { "disable-connected-check": "true", }, "bfd": { "enable": "true" }, "ipv4-unicast": { "allow-own-as-count": 10, "next-hop-self": "true", "route-map-import": "rmap2" }, "ipv6-unicast": { "enable": "true" }}Modify a BGP peer group
Section titled “Modify a BGP peer group”PATCH HTTPS://{switch IP}/rest/v1/running/bgp/Vrf1/peer-groups/PG1{ "ipv4-listen-range": ["10.1.1.0/24","20.1.1.0/24"], "ipv6-listen-range": ["2001:db8:1::/64","2001:db8:2::/64"]}Create an extended community list
Section titled “Create an extended community list”POST HTTPS://{switch IP}/rest/v1/running/extended-community-lists[ { "name": "test", "sequence-number": 1, "set-type": "EXPANDED", "match-action": "permit", "community-member": "65121" }]Create an extended numbered community list
Section titled “Create an extended numbered community list”POST HTTPS://{switch IP}/rest/v1/running/extended-numbered-community-lists[ { "list-number": 101, "sequence-number": 1, "match-action": "permit", "community-member": "65121" }]Create a community list
Section titled “Create a community list”POST HTTPS://{switch IP}/rest/v1/running/community-lists[ { "name": "test", "sequence-number": 1, "set-type": "EXPANDED", "match-action": "permit", "community-member": "65121" }]Create a numbered community list
Section titled “Create a numbered community list”POST HTTPS://{switch IP}/rest/v1/running/numbered-community-lists[ { "list-number": 101, "sequence-number": 1, "match-action": "permit", "community-member": "65121" }]Create a community alias
Section titled “Create a community alias”POST HTTPS://{switch IP}/rest/v1/running/community-aliases[ { "name": "65123:12", "alias": "test" }]Create an as-path access list
Section titled “Create an as-path access list”POST HTTPS://{switch IP}/rest/v1/running/as-path-access-lists[ { "name": "test", "sequence-number": 1, "match-action": "permit", "as-path-set-member": "65121" }]Properties Descriptions
Section titled “Properties Descriptions”BGP instance global
Section titled “BGP instance global”Tree Diagrams
+--rw bgp | +--rw bgp-instance* [vrf-name] | +--rw vrf-name | +--rw global | | +--rw as-number | | +--rw router-id? | | +--rw med-config | | | +--rw max-med-onstart-up-time? | | | +--rw max-med-onstart-up-value? | | +--rw route-selection | | | +--rw multipath-relax? | | | +--rw multi-path-as-set? | | +--rw graceful-shutdown? | | +--rw default-shutdown? | | +--rw ebgp-requires-policy? | | +--rw always-compare-med? | | +--rw dynamic-neighbors-limit? | | +--rw reject-as-sets? | | +--rw admin-shutdown? | | +--rw admin-shutdown-message? | | +--rw route-map-delay-time? | | +--rw graceful-restart? | | +--rw graceful-restart-restart-time? | | +--rw default-ipv4-unicast? | | +--rw default-ipv6-unicast? | | +--rw default-l2vpn-evpn? | | +--rw ipv4-unicast | | | +--rw networks* [prefix] | | | | +--rw prefix | | | | +--rw backdoor? | | | | +--rw route-map? | | | +--rw aggregate-route* [prefix] | | | | +--rw prefix | | | | +--rw as-set? | | | | +--rw summary-only? | | | | +--rw route-map-export? | | | | +--rw origin? | | | | +--rw match-med? | | | | +--rw suppress-map? | | | +--rw ebgp-maximum-paths? | | | +--rw ibgp-maximum-paths? | | | +--rw ibgp-cluster-length-list? | | | +--rw redistribution* [route-type] | | | | +--rw route-type | | | | +--rw metric? | | | | +--rw route-map-import? | | | +--rw distance | | | | +--rw ebgp-distance? | | | | +--rw ibgp-distance? | | | | +--rw local-distance? | | | +--rw route-map-export? | | | +--rw import-vrf* | | | +--rw import-vrf-route-map? | | +--rw ipv6-unicast | | | +--rw networks* [prefix] | | | | +--rw prefix | | | | +--rw backdoor? | | | | +--rw route-map? | | | +--rw aggregate-route* [prefix] | | | | +--rw prefix | | | | +--rw as-set? | | | | +--rw summary-only? | | | | +--rw route-map-export? | | | | +--rw origin? | | | | +--rw match-med? | | | | +--rw suppress-map? | | | +--rw ebgp-maximum-paths? | | | +--rw ibgp-maximum-paths? | | | +--rw ibgp-cluster-length-list? | | | +--rw redistribution* [route-type] | | | | +--rw route-type | | | | +--rw metric? | | | | +--rw route-map-import? | | | +--rw distance | | | | +--rw ebgp-distance? | | | | +--rw ibgp-distance? | | | | +--rw local-distance? | | | +--rw route-map-export? | | | +--rw import-vrf* | | | +--rw import-vrf-route-map? | | +--rw l2vpn-evpn | | +--rw advertise-all-vni? | | +--rw advertise-default-gateway? | | +--rw advertise-svi-ip? | | +--rw advertise-pip? | | +--rw advertise-pip-ip? | | +--rw advertise-pip-mac? | | +--rw default-originate-ipv4? | | +--rw default-originate-ipv6? | | +--rw advertise-ipv4-unicast? | | +--rw advertise-ipv6-unicast? | | +--rw route-distinguisher? | | +--rw rt-import-list* | | +--rw rt-export-list*Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| bgp | M | Path-only node, has no configurable value. | |
| Top-level configuration for the BGP router. | |||
| vrf-name | M | ”default” | |
| vrf name | (sub-property of bgp) | ||
| Name of the VRF instance. | |||
| global | M | (sub-property of bgp) | |
| Path-only node, has no configurable value. | |||
| as-number | M | 0..4294967295 | (sub-property of global) |
| Local autonomous system number. | |||
| router-id | O | A.B.C.D | (sub-property of global) |
| Router id of the BGP router. | |||
| med-config | M | (sub-property of global) | |
| Path-only node, has no configurable value. | |||
| max-med-onstart-up-time | O | 5..86400 | (sub-property of med-config) |
| Tells the router to announce routes with MED value, This MED value is applicable for this duration during start-up. | |||
| max-med-onstart-up-value | O | 0..4294967295 | (sub-property of med-config) |
| Tells the router to announce routes with this MED value This MED value is applicable for start-up time. | |||
| Default value: 4294967294 | |||
| route-selection | M | (sub-property of global) | |
| Path-only node, has no configurable value. | |||
| Grouping for route selection configuration | |||
| multipath-relax | O | ”true" | |
| "false” | (sub-property of route-selection) | ||
| Allow load sharing across routes that have different AS paths. | |||
| Default value: “false” | |||
| multi-path-as-set | CO | ”true" | |
| "false” | (sub-property of route-selection) | ||
| Only applicable when multipath-relax = “true”. | |||
| Multi-path with AS-SET, When set to “true” it adds AS set information for aggregate routes, When set to “false” it prevents AS set generation. | |||
| Default value: “false” | |||
| graceful-shutdown | O | ”true" | |
| "false” | (sub-property of global) | ||
| Enable graceful-shutdown feature. | |||
| Default value: “false” | |||
| default-shutdown | O | ”true" | |
| "false” | (sub-property of global) | ||
| Apply administrative shutdown to newly configured peers. | |||
| Default value: “false” | |||
| ebgp-requires-policy | O | ”true" | |
| "false” | (sub-property of global) | ||
| When set to “true” BGP speaker requires in and out policy for EBGP peers (RFC8212). | |||
| Default value: “true” | |||
| always-compare-med | O | ”true" | |
| "false” | (sub-property of global) | ||
| When set to “true” BGP always compares MED attribute across different neighboring ASes. | |||
| Default value: “false” | |||
| dynamic-neighbors-limit | O | 1..65535 | (sub-property of global) |
| Maximum number of BGP Dynamic Neighbors that can be created. | |||
| reject-as-sets | O | ”true" | |
| "false” | (sub-property of global) | ||
| Reject AS-SET in BGP updates. | |||
| Default value: “false” | |||
| admin-shutdown | O | ”true" | |
| "false” | (sub-property of global) | ||
| Shutdown BGP. | |||
| Default value: “false” | |||
| admin-shutdown-message | O | string | (sub-property of global) |
| Shutdown message. | |||
| route-map-delay-time | O | 0..600 | (sub-property of global) |
| Route map delay. | |||
| Default value: 5 | |||
| graceful-restart | O | ”true" | |
| "false” | (sub-property of global) | ||
| Enable BGP graceful restart. | |||
| Default value: “false” | |||
| graceful-restart-restart-time | O | 0..4095 | (sub-property of global) |
| Time to wait before restarting the BGP session. | |||
| Default value: 120 | |||
| default-ipv4-unicast | O | ”true" | |
| "false” | (sub-property of global) | ||
| Default value: “true” | |||
| default-ipv6-unicast | O | ”true" | |
| "false” | (sub-property of global) | ||
| Default value: “false” | |||
| default-l2vpn-evpn | O | ”true" | |
| "false” | (sub-property of global) | ||
| Default value: “false” | |||
| ipv4-unicast | M | (sub-property of global) | |
| Path-only node, has no configurable value. | |||
| IPv4 unicast configuration options. | |||
| networks | M | (sub-property of ipv4-unicast) | |
| Path-only node, has no configurable value. | |||
| A list of network routes. | |||
| prefix | M | A.B.C.D/M | (sub-property of networks) |
| IPv4 destination prefix. | |||
| backdoor | O | ”true" | |
| "false” | (sub-property of networks) | ||
| Specify a BGP backdoor route. | |||
| Default value: “false” | |||
| route-map | O | string | (sub-property of networks) |
| Route map to apply to network route. | |||
| aggregate-route | M | (sub-property of ipv4-unicast) | |
| Path-only node, has no configurable value. | |||
| A list of aggregated routes. | |||
| prefix | M | A.B.C.D/M | (sub-property of aggregate-route) |
| IPv4 destination prefix. | |||
| as-set | O | ”true" | |
| "false” | (sub-property of aggregate-route) | ||
| When set to “true” AS set path information is generated for aggregate address. When set to “false” AS set path information is not generated. | |||
| Default value: “false” | |||
| summary-only | O | ”true" | |
| "false” | (sub-property of aggregate-route) | ||
| When set to “true” it advertise only the aggregate route and suppress the advertisement of all the component routes. When set to “false” all more-specific routes summarized by the aggregate route are advertised. | |||
| Default value: “false” | |||
| route-map-export | O | string | (sub-property of aggregate-route) |
| Route map to apply to aggregate route. | |||
| origin | O | ”igp" | |
| "egp" | |||
| "incomplete" | |||
| "unspecified” | (sub-property of aggregate-route) | ||
| BGP origin type. | |||
| Default value: “unspecified” | |||
| match-med | O | ”true" | |
| "false” | (sub-property of aggregate-route) | ||
| When set to “true” aggregate-route matches only med. | |||
| Default value: “false” | |||
| suppress-map | O | string | (sub-property of aggregate-route) |
| Suppress more specific routes specified in route-map. | |||
| ebgp-maximum-paths | O | 0..65535 | (sub-property of ipv4-unicast) |
| Maximum number of parallel paths to consider when using BGP multi-path for EBGP. The default is to use a single path. | |||
| Default value: 256 | |||
| ibgp-maximum-paths | O | 0..65535 | (sub-property of ipv4-unicast) |
| Maximum number of parallel paths to consider when using BGP multi-path for IBGP. The default is to use a single path. | |||
| Default value: 256 | |||
| ibgp-cluster-length-list | CO | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| Only applicable when ibgp-maximum-paths != 0. | |||
| When set to “true” route with the shortest cluster-list length is used. The cluster-list reflects the IBGP reflection path the route has taken. It’s the part of route selection algo. | |||
| Default value: “false” | |||
| redistribution | M | (sub-property of ipv4-unicast) | |
| Path-only node, has no configurable value. | |||
| route-type | M | route-types | (sub-property of redistribution) |
| Protocol route type. | |||
| metric | O | 0..4294967295 | (sub-property of redistribution) |
| Metric for redistributed routes. | |||
| route-map-import | O | string | (sub-property of redistribution) |
| distance | M | (sub-property of ipv4-unicast) | |
| Path-only node, has no configurable value. | |||
| ebgp-distance | O | 1..255 | (sub-property of distance) |
| Administrative distance for EBGP routes. | |||
| ibgp-distance | O | 1..255 | (sub-property of distance) |
| Administrative distance for IBGP routes. | |||
| local-distance | O | 1..255 | (sub-property of distance) |
| Administrative distance for locally originated routes. | |||
| route-map-export | O | string | (sub-property of ipv4-unicast) |
| Route map for route advertisement. | |||
| import-vrf | O | ”default” | |
| vrf name | (sub-property of ipv4-unicast) | ||
| Import VRF for the address family. | |||
| import-vrf-route-map | O | string | (sub-property of ipv4-unicast) |
| Import VRF route map for the address family. | |||
| ipv6-unicast | M | (sub-property of global) | |
| Path-only node, has no configurable value. | |||
| IPv6 unicast configuration options. | |||
| networks | M | (sub-property of ipv6-unicast) | |
| Path-only node, has no configurable value. | |||
| A list of network routes. | |||
| prefix | M | XX:XX:XX:XX:XX:XX:XX:XX/M | (sub-property of networks) |
| IPv6 destination prefix. | |||
| backdoor | O | ”true" | |
| "false” | (sub-property of networks) | ||
| Specify a BGP backdoor route. | |||
| Default value: “false” | |||
| route-map | O | string | (sub-property of networks) |
| Route map to apply to network route. | |||
| aggregate-route | M | (sub-property of ipv6-unicast) | |
| Path-only node, has no configurable value. | |||
| A list of aggregated routes. | |||
| prefix | M | XX:XX:XX:XX:XX:XX:XX:XX/M | (sub-property of aggregate-route) |
| IPv6 destination prefix. | |||
| as-set | O | ”true" | |
| "false” | (sub-property of aggregate-route) | ||
| When set to “true” AS set path information is generated for aggregate address. When set to “false” AS set path information is not generated. | |||
| Default value: “false” | |||
| summary-only | O | ”true" | |
| "false” | (sub-property of aggregate-route) | ||
| When set to “true” it advertise only the aggregate route and suppress the advertisement of all the component routes. When set to “false” all more-specific routes summarized by the aggregate route are advertised. | |||
| Default value: “false” | |||
| route-map-export | O | string | (sub-property of aggregate-route) |
| Route map to apply to aggregate route. | |||
| origin | O | ”igp" | |
| "egp" | |||
| "incomplete" | |||
| "unspecified” | (sub-property of aggregate-route) | ||
| BGP origin type. | |||
| Default value: “unspecified” | |||
| match-med | O | ”true" | |
| "false” | (sub-property of aggregate-route) | ||
| When set to “true” aggregate-route matches only med. | |||
| Default value: “false” | |||
| suppress-map | O | string | (sub-property of aggregate-route) |
| Suppress more specific routes specified in route-map. | |||
| ebgp-maximum-paths | O | 0..65535 | (sub-property of ipv6-unicast) |
| Maximum number of parallel paths to consider when using BGP multi-path for EBGP. The default is to use a single path. | |||
| Default value: 256 | |||
| ibgp-maximum-paths | O | 0..65535 | (sub-property of ipv6-unicast) |
| Maximum number of parallel paths to consider when using BGP multi-path for IBGP. The default is to use a single path. | |||
| Default value: 256 | |||
| ibgp-cluster-length-list | CO | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| Only applicable when ibgp-maximum-paths != 0. | |||
| When set to “true” route with the shortest cluster-list length is used. The cluster-list reflects the IBGP reflection path the route has taken. It’s the part of route selection algo. | |||
| Default value: “false” | |||
| redistribution | M | (sub-property of ipv6-unicast) | |
| Path-only node, has no configurable value. | |||
| route-type | M | route-types | (sub-property of redistribution) |
| Protocol route type. | |||
| metric | O | 0..4294967295 | (sub-property of redistribution) |
| Metric for redistributed routes. | |||
| route-map-import | O | string | (sub-property of redistribution) |
| distance | M | (sub-property of ipv6-unicast) | |
| Path-only node, has no configurable value. | |||
| ebgp-distance | O | 1..255 | (sub-property of distance) |
| Administrative distance for EBGP routes. | |||
| ibgp-distance | O | 1..255 | (sub-property of distance) |
| Administrative distance for IBGP routes. | |||
| local-distance | O | 1..255 | (sub-property of distance) |
| Administrative distance for locally originated routes. | |||
| route-map-export | O | string | (sub-property of ipv6-unicast) |
| Route map for route advertisement. | |||
| import-vrf | O | ”default” | |
| vrf name | (sub-property of ipv6-unicast) | ||
| Import VRF for the address family. | |||
| import-vrf-route-map | O | string | (sub-property of ipv6-unicast) |
| Import VRF route map for the address family. | |||
| l2vpn-evpn | M | (sub-property of global) | |
| Path-only node, has no configurable value. | |||
| BGP EVPN configuration options. | |||
| advertise-all-vni | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Advertise all VNI. | |||
| Default value: “false” | |||
| advertise-default-gateway | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Advertise default gateway. | |||
| Default value: “false” | |||
| advertise-svi-ip | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Advertise SVI IP. Note that you should not enable both the advertise-svi-ip and the advertise-default-gw at the same time. | |||
| Default value: “false” | |||
| advertise-pip | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Advertise PIP. | |||
| Default value: “true” | |||
| advertise-pip-ip | O | A.B.C.D | (sub-property of l2vpn-evpn) |
| advertise-pip-mac | O | A:B:C:D:E:F | (sub-property of l2vpn-evpn) |
| default-originate-ipv4 | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Advertise default route. | |||
| Default value: “false” | |||
| default-originate-ipv6 | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Advertise default route. | |||
| Default value: “false” | |||
| advertise-ipv4-unicast | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Advertise IPv4 unicast. | |||
| Default value: “false” | |||
| advertise-ipv6-unicast | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Advertise IPv6 unicast. | |||
| Default value: “false” | |||
| route-distinguisher | O | string | (sub-property of l2vpn-evpn) |
| Route distinguisher. | |||
| rt-import-list | O | string | (sub-property of l2vpn-evpn) |
| Route target import list. | |||
| rt-export-list | O | string | (sub-property of l2vpn-evpn) |
| Route target export list. |
BGP instance neighbors
Section titled “BGP instance neighbors”Tree Diagrams
+--rw bgp | +--rw bgp-instance* [vrf-name] | +--rw vrf-name | +--rw neighbors | | +--rw neighbor* [address-or-interface] | | +--rw address-or-interface | | +--rw peer-group-name? | | +--rw remote-as-type? | | +--rw remote-as? | | +--rw local-as? | | +--rw no-prepend? | | +--rw replace-as? | | +--rw description? | | +--rw password? | | +--rw solo? | | +--rw as-path-loop-detect? | | +--rw tcp-mss? | | +--rw local-address? | | +--rw ebgp-multihop | | | +--rw enabled? | | | +--rw multihop-ttl? | | | +--rw disable-connected-check? | | +--rw bfd | | | +--rw enable? | | | +--rw check-ctrlplane-failure? | | | +--rw profile? | | +--rw admin-status? | | +--rw admin-shutdown-message? | | +--rw graceful-restart? | | +--rw graceful-restart-helper? | | +--rw ipv4-unicast | | | +--rw enable? | | | +--rw default-enable? | | | +--rw allow-own-as? | | | +--rw allow-own-as-count? | | | +--rw allow-own-origin-as? | | | +--rw default-originate? | | | +--rw default-originate-route-map? | | | +--rw next-hop-self? | | | +--rw next-hop-self-force? | | | +--rw route-reflector-client? | | | +--rw soft-reconfiguration? | | | +--rw route-map-import? | | | +--rw route-map-export? | | | +--rw as-override? | | +--rw ipv6-unicast | | | +--rw enable? | | | +--rw default-enable? | | | +--rw allow-own-as? | | | +--rw allow-own-as-count? | | | +--rw allow-own-origin-as? | | | +--rw default-originate? | | | +--rw default-originate-route-map? | | | +--rw next-hop-self? | | | +--rw next-hop-self-force? | | | +--rw route-reflector-client? | | | +--rw soft-reconfiguration? | | | +--rw route-map-import? | | | +--rw route-map-export? | | | +--rw as-override? | | +--rw l2vpn-evpn | | +--rw enable? | | +--rw default-enable? | | +--rw allow-own-as? | | +--rw allow-own-as-count? | | +--rw allow-own-origin-as? | | +--rw next-hop-self? | | +--rw next-hop-self-force? | | +--rw route-reflector-client? | | +--rw soft-reconfiguration? | | +--rw route-map-import? | | +--rw route-map-export?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| bgp | M | Path-only node, has no configurable value. | |
| Top-level configuration for the BGP router. | |||
| vrf-name | M | ”default” | |
| vrf name | (sub-property of bgp) | ||
| Name of the VRF instance. | |||
| neighbors | M | (sub-property of bgp) | |
| Path-only node, has no configurable value. | |||
| address-or-interface | M | ”A.B.C.D | |
| XX:XX:XX:XX:XX:XX:XX:XX” | |||
| Interface name | (sub-property of neighbors) | ||
| Neighbor’s address or interface name. | |||
| peer-group-name | O | peer-group name | (sub-property of neighbors) |
| Peer group of the BGP neighbor. | |||
| remote-as-type | O | ”internal" | |
| "external” | (sub-property of neighbors) |
|| remote-as | O | 0..4294967295 | (sub-property of neighbors) The remote autonomous system number received in the BGP OPEN message. | | local-as | O | 1..4294967295 | (sub-property of neighbors) The local autonomous system number that is to be used when establishing sessions with the remote peer or peer group, if this differs from the global BGP router autonomous system number. | | no-prepend | CO | “true” “false” | (sub-property of neighbors) Only applicable when local-as != 0. Do not prepend local-as to updates from EBGP peers. When set to “true” it will not prepend local-as to updates. When set to “false” it will prepend local-as to updates. Default value: “false” | | replace-as | O | “true” “false” | (sub-property of neighbors) Do not prepend local-as to updates from IBGP peers. Default value: “false” | | description | O | string | (sub-property of neighbors) Description of the neighbor. | | password | O | A string that represents a credential, such as a password or a key for OSPF/BGP sessions | (sub-property of neighbors) Actual password. | | solo | O | “true” “false” | (sub-property of neighbors) Solo peer - part of its own update group. Default value: “false” | | as-path-loop-detect | O | “true” “false” | (sub-property of neighbors) AS_PATH loop detection. Default value: “false” | | tcp-mss | O | 0..65535 | (sub-property of neighbors) TCP MSS value. | | local-address | O | “A.B.C.D XX:XX:XX:XX:XX:XX:XX:XX” Interface name | (sub-property of neighbors) Local address for the BGP connection. | | ebgp-multihop | M | | (sub-property of neighbors) Path-only node, has no configurable value. EBGP multi-hop parameters for the BGP group. | | enabled | O | “true” “false” | (sub-property of ebgp-multihop) When enabled the referenced group or neighbors are permitted to be indirectly connected - including cases where the TTL can be decremented between the BGP peers. Default value: “false” | | multihop-ttl | O | 1..255 | (sub-property of ebgp-multihop) Time-to-live value to use when packets are sent to the referenced group or neighbors and ebgp-multihop is enabled. | | disable-connected-check | O | “true” “false” | (sub-property of ebgp-multihop) When set to “true” it enforces EBGP neighbors perform multihop. Default value: “false” | | bfd | M | | (sub-property of neighbors) Path-only node, has no configurable value. | | enable | O | “true” “false” | (sub-property of bfd) BFD support. Default value: “false” | | check-ctrlplane-failure | CO | “true” “false” | (sub-property of bfd) Only applicable when enable = “true”. Link dataplane status with BGP control plane. Default value: “false” | | profile | CO | string | (sub-property of bfd) Only applicable when enable = “true”. BFD profile name. | | admin-status | O | “true” “false” | (sub-property of neighbors) When set to “true”, BGP shutdown communication is enabled. | | admin-shutdown-message | CO | string | (sub-property of neighbors) Only applicable when admin-status = “true”. Shutdown message. | | graceful-restart | O | “true” “false” | (sub-property of neighbors) Enable or disable the graceful-restart capability. Setting this value to “true” enables the graceful-restart and helper both at peer level. Setting this value to “false” disables graceful restart and helper mode. The peer will inherit global configuration. Default value: “false” | | graceful-restart-helper | O | “true” “false” | (sub-property of neighbors) Setting this value to “true” enables helper mode for the peer Setting this value to “false” disables the helper mode. The peer will inherit global configuration. Default value: “false” | | ipv4-unicast | M | | (sub-property of neighbors) Path-only node, has no configurable value. IPv4 unicast configuration options. | | enable | O | “true” “false” | (sub-property of ipv4-unicast) Enable the neighbor. Default value: “true” | | default-enable | O | “true” “false” | (sub-property of ipv4-unicast) Enable default ipv4 unicast. Default value: “true” | | allow-own-as | O | “true” “false” | (sub-property of ipv4-unicast) When set to “true” only accept my AS in the as-path. Default value: “false” | | allow-own-as-count | O | 1..10 | (sub-property of ipv4-unicast) Specify the number of occurrences of the local BGP speaker’s AS that can occur within the AS_PATH before it is rejected. | | allow-own-origin-as | O | “true” “false” | (sub-property of ipv4-unicast) When set to “true” only accept my AS in the as-path if the route was originated in my AS. This is mutually exclusive with allow-own-as-count. Default value: “false” | | default-originate | O | “true” “false” | (sub-property of ipv4-unicast) If set to “true”, send the default-route to the neighbour(s). Default value: “false” | | default-originate-route-map | O | string | (sub-property of ipv4-unicast) Route-map to specify criteria to originate default. | | next-hop-self | O | “true” “false” | (sub-property of ipv4-unicast) When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. Default value: “false” | | next-hop-self-force | O | “true” “false” | (sub-property of ipv4-unicast) When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. Default value: “false” | | route-reflector-client | O | “true” “false” | (sub-property of ipv4-unicast) Configure a neighbor as route reflector client. Default value: “false” | | soft-reconfiguration | O | “true” “false” | (sub-property of ipv4-unicast) Allow inbound soft reconfiguration for this neighbor. Default value: “false” | | route-map-import | O | string | (sub-property of ipv4-unicast) | | route-map-export | O | string | (sub-property of ipv4-unicast) | | as-override | O | “true” “false” | (sub-property of ipv4-unicast) When set to “true” it will override the AS number in the received BGP update with the local AS number. Default value: “false” | | ipv6-unicast | M | | (sub-property of neighbors) Path-only node, has no configurable value. IPv6 unicast configuration options. | | enable | O | “true” “false” | (sub-property of ipv6-unicast) Enable the neighbor. Default value: “false” | | default-enable | O | “true” “false” | (sub-property of ipv6-unicast) Enable default ipv6 unicast. Default value: “false” | | allow-own-as | O | “true” “false” | (sub-property of ipv6-unicast) When set to “true” only accept my AS in the as-path. Default value: “false” | | allow-own-as-count | O | 1..10 | (sub-property of ipv6-unicast) Specify the number of occurrences of the local BGP speaker’s AS that can occur within the AS_PATH before it is rejected. | | allow-own-origin-as | O | “true” “false” | (sub-property of ipv6-unicast) When set to “true” only accept my AS in the as-path if the route was originated in my AS. This is mutually exclusive with allow-own-as-count. Default value: “false” | | default-originate | O | “true” “false” | (sub-property of ipv6-unicast) If set to “true”, send the default-route to the neighbour(s). Default value: “false” | | default-originate-route-map | O | string | (sub-property of ipv6-unicast) Route-map to specify criteria to originate default. | | next-hop-self | O | “true” “false” | (sub-property of ipv6-unicast) When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. Default value: “false” | | next-hop-self-force | O | “true” “false” | (sub-property of ipv6-unicast) When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. Default value: “false” | | route-reflector-client | O | “true” “false” | (sub-property of ipv6-unicast) Configure a neighbor as route reflector client. Default value: “false” | | soft-reconfiguration | O | “true” “false” | (sub-property of ipv6-unicast) Allow inbound soft reconfiguration for this neighbor. Default value: “false” | | route-map-import | O | string | (sub-property of ipv6-unicast) | | route-map-export | O | string | (sub-property of ipv6-unicast) | | as-override | O | “true” “false” | (sub-property of ipv6-unicast) When set to “true” it will override the AS number in the received BGP update with the local AS number. Default value: “false” | | l2vpn-evpn | M | | (sub-property of neighbors) Path-only node, has no configurable value. BGP EVPN configuration options. | | enable | O | “true” “false” | (sub-property of l2vpn-evpn) Enable the neighbor. Default value: “false” | | default-enable | O | “true” “false” | (sub-property of l2vpn-evpn) Enable default l2vpn evpn. Default value: “false” | | allow-own-as | O | “true” “false” | (sub-property of l2vpn-evpn) When set to “true” only accept my AS in the as-path. Default value: “false” | | allow-own-as-count | O | 1..10 | (sub-property of l2vpn-evpn) Specify the number of occurrences of the local BGP speaker’s AS that can occur within the AS_PATH before it is rejected. | | allow-own-origin-as | O | “true” “false” | (sub-property of l2vpn-evpn) When set to “true” only accept my AS in the as-path if the route was originated in my AS. This is mutually exclusive with allow-own-as-count. Default value: “false” | | next-hop-self | O | “true” “false” | (sub-property of l2vpn-evpn) When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. Default value: “false” | | next-hop-self-force | O | “true” “false” | (sub-property of l2vpn-evpn) When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. Default value: “false” | | route-reflector-client | O | “true” “false” | (sub-property of l2vpn-evpn) Configure a neighbor as route reflector client. Default value: “false” | | soft-reconfiguration | O | “true” “false” | (sub-property of l2vpn-evpn) Allow inbound soft reconfiguration for this neighbor. Default value: “false” | | route-map-import | O | string | (sub-property of l2vpn-evpn) | | route-map-export | O | string | (sub-property of l2vpn-evpn) |
BGP instance peer groups
Section titled “BGP instance peer groups”Tree Diagrams
+--rw bgp | +--rw bgp-instance* [vrf-name] | +--rw vrf-name | +--rw peer-groups | +--rw peer-group* [name] | +--rw name | +--rw ipv4-listen-range* | +--rw ipv6-listen-range* | +--rw remote-as-type? | +--rw remote-as? | +--rw local-as? | +--rw no-prepend? | +--rw replace-as? | +--rw description? | +--rw password? | +--rw solo? | +--rw as-path-loop-detect? | +--rw tcp-mss? | +--rw local-address? | +--rw ebgp-multihop | | +--rw enabled? | | +--rw multihop-ttl? | | +--rw disable-connected-check? | +--rw bfd | | +--rw enable? | | +--rw check-ctrlplane-failure? | | +--rw profile? | +--rw admin-status? | +--rw admin-shutdown-message? | +--rw graceful-restart? | +--rw graceful-restart-helper? | +--rw ipv4-unicast | | +--rw enable? | | +--rw default-enable? | | +--rw allow-own-as? | | +--rw allow-own-as-count? | | +--rw allow-own-origin-as? | | +--rw default-originate? | | +--rw default-originate-route-map? | | +--rw next-hop-self? | | +--rw next-hop-self-force? | | +--rw route-reflector-client? | | +--rw soft-reconfiguration? | | +--rw route-map-import? | | +--rw route-map-export? | | +--rw as-override? | +--rw ipv6-unicast | | +--rw enable? | | +--rw default-enable? | | +--rw allow-own-as? | | +--rw allow-own-as-count? | | +--rw allow-own-origin-as? | | +--rw default-originate? | | +--rw default-originate-route-map? | | +--rw next-hop-self? | | +--rw next-hop-self-force? | | +--rw route-reflector-client? | | +--rw soft-reconfiguration? | | +--rw route-map-import? | | +--rw route-map-export? | | +--rw as-override? | +--rw l2vpn-evpn | +--rw enable? | +--rw default-enable? | +--rw allow-own-as? | +--rw allow-own-as-count? | +--rw allow-own-origin-as? | +--rw next-hop-self? | +--rw next-hop-self-force? | +--rw route-reflector-client? | +--rw soft-reconfiguration? | +--rw route-map-import? | +--rw route-map-export?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| bgp | M | Path-only node, has no configurable value. | |
| Top-level configuration for the BGP router. | |||
| vrf-name | M | ”default” | |
| vrf name | (sub-property of bgp) | ||
| Name of the VRF instance. | |||
| peer-groups | M | (sub-property of bgp) | |
| Path-only node, has no configurable value. | |||
| name | M | string | (sub-property of peer-groups) |
| Name of the BGP peer group. | |||
| ipv4-listen-range | O | A.B.C.D/M | (sub-property of peer-groups) |
| Configure BGP dynamic neighbors listen range. | |||
| ipv6-listen-range | O | XX:XX:XX:XX:XX:XX:XX:XX/M | (sub-property of peer-groups) |
| Configure BGP dynamic neighbors listen range. | |||
| remote-as-type | O | ”internal" | |
| "external” | (sub-property of peer-groups) | ||
| remote-as | O | 0..4294967295 | (sub-property of peer-groups) |
| The remote autonomous system number received in the BGP OPEN message. | |||
| local-as | O | 1..4294967295 | (sub-property of peer-groups) |
| The local autonomous system number that is to be used when establishing sessions with the remote peer or peer group, if this differs from the global BGP router autonomous system number. | |||
| no-prepend | CO | ”true" | |
| "false” | (sub-property of peer-groups) | ||
| Only applicable when local-as != 0. | |||
| Do not prepend local-as to updates from EBGP peers. When set to “true” it will not prepend local-as to updates. When set to “false” it will prepend local-as to updates. | |||
| Default value: “false” | |||
| replace-as | O | ”true" | |
| "false” | (sub-property of peer-groups) | ||
| Do not prepend local-as to updates from IBGP peers. | |||
| Default value: “false” | |||
| description | O | string | (sub-property of peer-groups) |
| Description of the neighbor. | |||
| password | O | A string that represents a credential, such as a password or a key for OSPF/BGP sessions | (sub-property of peer-groups) |
| Actual password. | |||
| solo | O | ”true" | |
| "false” | (sub-property of peer-groups) | ||
| Solo peer - part of its own update group. | |||
| Default value: “false” | |||
| as-path-loop-detect | O | ”true" | |
| "false” | (sub-property of peer-groups) | ||
| AS_PATH loop detection. | |||
| Default value: “false” | |||
| tcp-mss | O | 0..65535 | (sub-property of peer-groups) |
| TCP MSS value. | |||
| local-address | O | ”A.B.C.D | |
| XX:XX:XX:XX:XX:XX:XX:XX” | |||
| Interface name | (sub-property of peer-groups) | ||
| Local address for the BGP connection. | |||
| ebgp-multihop | M | (sub-property of peer-groups) | |
| Path-only node, has no configurable value. | |||
| EBGP multi-hop parameters for the BGP group. | |||
| enabled | O | ”true" | |
| "false” | (sub-property of ebgp-multihop) | ||
| When enabled the referenced group or neighbors are permitted to be indirectly connected - including cases where the TTL can be decremented between the BGP peers. | |||
| Default value: “false” | |||
| multihop-ttl | O | 1..255 | (sub-property of ebgp-multihop) |
| Time-to-live value to use when packets are sent to the referenced group or neighbors and ebgp-multihop is enabled. | |||
| disable-connected-check | O | ”true" | |
| "false” | (sub-property of ebgp-multihop) | ||
| When set to “true” it enforces EBGP neighbors perform multihop. | |||
| Default value: “false” | |||
| bfd | M | (sub-property of peer-groups) | |
| Path-only node, has no configurable value. | |||
| enable | O | ”true" | |
| "false” | (sub-property of bfd) | ||
| BFD support. | |||
| Default value: “false” | |||
| check-ctrlplane-failure | CO | ”true" | |
| "false” | (sub-property of bfd) | ||
| Only applicable when enable = “true”. | |||
| Link dataplane status with BGP control plane. | |||
| Default value: “false” | |||
| profile | CO | string | (sub-property of bfd) |
| Only applicable when enable = “true”. | |||
| BFD profile name. | |||
| admin-status | O | ”true" | |
| "false” | (sub-property of peer-groups) | ||
| When set to “true”, BGP shutdown communication is enabled. | |||
| admin-shutdown-message | CO | string | (sub-property of peer-groups) |
| Only applicable when admin-status = “true”. | |||
| Shutdown message. | |||
| graceful-restart | O | ”true" | |
| "false” | (sub-property of peer-groups) | ||
| Enable or disable the graceful-restart capability. Setting this value to “true” enables the graceful-restart and helper both at peer level. Setting this value to “false” disables graceful restart and helper mode. The peer will inherit global configuration. | |||
| Default value: “false” | |||
| graceful-restart-helper | O | ”true" | |
| "false” | (sub-property of peer-groups) | ||
| Setting this value to “true” enables helper mode for the peer Setting this value to “false” disables the helper mode. The peer will inherit global configuration. | |||
| Default value: “false” | |||
| ipv4-unicast | M | (sub-property of peer-groups) | |
| Path-only node, has no configurable value. | |||
| IPv4 unicast configuration options. | |||
| enable | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| Enable the neighbor. | |||
| Default value: “true” | |||
| default-enable | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| Enable default ipv4 unicast. | |||
| Default value: “true” | |||
| allow-own-as | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| When set to “true” only accept my AS in the as-path. | |||
| Default value: “false” | |||
| allow-own-as-count | O | 1..10 | (sub-property of ipv4-unicast) |
| Specify the number of occurrences of the local BGP speaker’s AS that can occur within the AS_PATH before it is rejected. | |||
| allow-own-origin-as | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| When set to “true” only accept my AS in the as-path if the route was originated in my AS. This is mutually exclusive with allow-own-as-count. | |||
| Default value: “false” | |||
| default-originate | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| If set to “true”, send the default-route to the neighbour(s). | |||
| Default value: “false” | |||
| default-originate-route-map | O | string | (sub-property of ipv4-unicast) |
| Route-map to specify criteria to originate default. | |||
| next-hop-self | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. | |||
| Default value: “false” | |||
| next-hop-self-force | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. | |||
| Default value: “false” | |||
| route-reflector-client | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| Configure a neighbor as route reflector client. | |||
| Default value: “false” | |||
| soft-reconfiguration | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| Allow inbound soft reconfiguration for this neighbor. | |||
| Default value: “false” | |||
| route-map-import | O | string | (sub-property of ipv4-unicast) |
| route-map-export | O | string | (sub-property of ipv4-unicast) |
| as-override | O | ”true" | |
| "false” | (sub-property of ipv4-unicast) | ||
| When set to “true” it will override the AS number in the received BGP update with the local AS number. | |||
| Default value: “false” | |||
| ipv6-unicast | M | (sub-property of peer-groups) | |
| Path-only node, has no configurable value. | |||
| IPv6 unicast configuration options. | |||
| enable | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| Enable the neighbor. | |||
| Default value: “false” | |||
| default-enable | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| Enable default ipv6 unicast. | |||
| Default value: “false” | |||
| allow-own-as | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| When set to “true” only accept my AS in the as-path. | |||
| Default value: “false” | |||
| allow-own-as-count | O | 1..10 | (sub-property of ipv6-unicast) |
| Specify the number of occurrences of the local BGP speaker’s AS that can occur within the AS_PATH before it is rejected. | |||
| allow-own-origin-as | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| When set to “true” only accept my AS in the as-path if the route was originated in my AS. This is mutually exclusive with allow-own-as-count. | |||
| Default value: “false” | |||
| default-originate | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| If set to “true”, send the default-route to the neighbour(s). | |||
| Default value: “false” | |||
| default-originate-route-map | O | string | (sub-property of ipv6-unicast) |
| Route-map to specify criteria to originate default. | |||
| next-hop-self | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. | |||
| Default value: “false” | |||
| next-hop-self-force | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. | |||
| Default value: “false” | |||
| route-reflector-client | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| Configure a neighbor as route reflector client. | |||
| Default value: “false” | |||
| soft-reconfiguration | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| Allow inbound soft reconfiguration for this neighbor. | |||
| Default value: “false” | |||
| route-map-import | O | string | (sub-property of ipv6-unicast) |
| route-map-export | O | string | (sub-property of ipv6-unicast) |
| as-override | O | ”true" | |
| "false” | (sub-property of ipv6-unicast) | ||
| When set to “true” it will override the AS number in the received BGP update with the local AS number. | |||
| Default value: “false” | |||
| l2vpn-evpn | M | (sub-property of peer-groups) | |
| Path-only node, has no configurable value. | |||
| BGP EVPN configuration options. | |||
| enable | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Enable the neighbor. | |||
| Default value: “false” | |||
| default-enable | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Enable default l2vpn evpn. | |||
| Default value: “false” | |||
| allow-own-as | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| When set to “true” only accept my AS in the as-path. | |||
| Default value: “false” | |||
| allow-own-as-count | O | 1..10 | (sub-property of l2vpn-evpn) |
| Specify the number of occurrences of the local BGP speaker’s AS that can occur within the AS_PATH before it is rejected. | |||
| allow-own-origin-as | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| When set to “true” only accept my AS in the as-path if the route was originated in my AS. This is mutually exclusive with allow-own-as-count. | |||
| Default value: “false” | |||
| next-hop-self | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. | |||
| Default value: “false” | |||
| next-hop-self-force | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| When set to “true”, EBGP learned routes are announced with the local speaker’s nexthop. | |||
| Default value: “false” | |||
| route-reflector-client | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Configure a neighbor as route reflector client. | |||
| Default value: “false” | |||
| soft-reconfiguration | O | ”true" | |
| "false” | (sub-property of l2vpn-evpn) | ||
| Allow inbound soft reconfiguration for this neighbor. | |||
| Default value: “false” | |||
| route-map-import | O | string | (sub-property of l2vpn-evpn) |
| route-map-export | O | string | (sub-property of l2vpn-evpn) |
BGP extended community lists
Section titled “BGP extended community lists”Tree Diagrams
+--rw extended-community-lists | +--rw extended-community-list* [name sequence-number] | +--rw name | +--rw sequence-number | +--rw set-type | +--rw match-action? | +--rw community-member?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| extended-community-lists | M | Path-only node, has no configurable value. | |
| name | M | string | (sub-property of extended-community-lists) |
| Name of extended community. | |||
| sequence-number | M | 0..4294967295 | |
| ”auto” | (sub-property of extended-community-lists) | ||
| The sequence number of the extcommunity-list entry, “auto” will automatically fill in the missing seq. | |||
| set-type | M | ”STANDARD" | |
| "EXPANDED” | (sub-property of extended-community-lists) | ||
| It tells the parser whether the community strings that follow are simple exact values (standard) or regex patterns (expanded). | |||
| match-action | O | ”deny" | |
| "permit” | (sub-property of extended-community-lists) | ||
| It sets the action for this entry: permit lets the route through, deny drops it. | |||
| Default value: “permit” | |||
| community-member | O | string | (sub-property of extended-community-lists) |
| Literal extended-community string(s) to be matched or denied. |
BGP extended numbered community lists
Section titled “BGP extended numbered community lists”Tree Diagrams
+--rw extended-numbered-community-lists | +--rw extended-numbered-community-list* [list-number sequence-number] | +--rw list-number | +--rw sequence-number | +--rw set-type? | +--rw match-action? | +--rw community-member?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| extended-numbered-community-lists | M | Path-only node, has no configurable value. | |
| list-number | M | 1..500 | (sub-property of extended-numbered-community-lists) |
| Numeric identifier (1-500) that can be assign to an extended-community list | |||
| sequence-number | M | 0..4294967295 | |
| ”auto” | (sub-property of extended-numbered-community-lists) | ||
| The sequence number of the extcommunity-list entry, “auto” will automatically fill in the missing seq. | |||
| set-type | O | ”STANDARD" | |
| "EXPANDED” | (sub-property of extended-numbered-community-lists) | ||
| It tells the parser whether the community strings that follow are simple exact values (standard) or regex patterns (expanded). | |||
| match-action | O | ”deny" | |
| "permit” | (sub-property of extended-numbered-community-lists) | ||
| It sets the action for this entry: permit lets the route through, deny drops it. | |||
| Default value: “permit” | |||
| community-member | O | string | (sub-property of extended-numbered-community-lists) |
| Literal extended-community string(s) to be matched or denied. |
BGP community lists
Section titled “BGP community lists”Tree Diagrams
+--rw community-lists | +--rw community-list* [name sequence-number] | +--rw name | +--rw sequence-number | +--rw set-type | +--rw match-action? | +--rw community-member?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| community-lists | M | Path-only node, has no configurable value. | |
| name | M | string | (sub-property of community-lists) |
| Name of community-list. | |||
| sequence-number | M | 0..4294967295 | |
| ”auto” | (sub-property of community-lists) | ||
| The sequence number of the community-list entry, “auto” will automatically fill in the missing seq. | |||
| set-type | M | ”STANDARD" | |
| "EXPANDED” | (sub-property of community-lists) | ||
| It tells the parser whether the community strings that follow are simple exact values (standard) or regex patterns (expanded). | |||
| match-action | O | ”deny" | |
| "permit” | (sub-property of community-lists) | ||
| It sets the action for this entry: permit lets the route through, deny drops it. | |||
| Default value: “permit” | |||
| community-member | O | string | (sub-property of community-lists) |
| Literal community string(s) to be matched or denied. |
BGP numbered community lists
Section titled “BGP numbered community lists”Tree Diagrams
+--rw numbered-community-lists | +--rw numbered-community-list* [list-number sequence-number] | +--rw list-number | +--rw sequence-number | +--rw set-type? | +--rw match-action? | +--rw community-member?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| numbered-community-lists | M | Path-only node, has no configurable value. | |
| list-number | M | 1..500 | (sub-property of numbered-community-lists) |
| Numeric identifier (1-500) that can be assign to an community list | |||
| sequence-number | M | 0..4294967295 | |
| ”auto” | (sub-property of numbered-community-lists) | ||
| The sequence number of the community-list entry, “auto” will automatically fill in the missing seq. | |||
| set-type | O | ”STANDARD" | |
| "EXPANDED” | (sub-property of numbered-community-lists) | ||
| It tells the parser whether the community strings that follow are simple exact values (standard) or regex patterns (expanded). | |||
| match-action | O | ”deny" | |
| "permit” | (sub-property of numbered-community-lists) | ||
| It sets the action for this entry: permit lets the route through, deny drops it. | |||
| Default value: “permit” | |||
| community-member | O | string | (sub-property of numbered-community-lists) |
| Literal community string(s) to be matched or denied. |
BGP community aliases
Section titled “BGP community aliases”Tree Diagrams
+--rw community-aliases | +--rw community-alias* [name] | +--rw name | +--rw aliasTable of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| community-aliases | M | Path-only node, has no configurable value. | |
| name | M | string | (sub-property of community-aliases) |
| Official community value that BGP will recognise in packets. | |||
| alias | M | string | (sub-property of community-aliases) |
| Short mnemonic word created to represent that value inside configuration commands, making scripts easier to read and maintain. |
BGP as-path access lists
Section titled “BGP as-path access lists”Tree Diagrams
+--rw as-path-access-lists +--rw as-path-access-list* [name sequence-number] +--rw name +--rw sequence-number +--rw match-action? +--rw as-path-set-member?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| as-path-access-lists | M | Path-only node, has no configurable value. | |
| name | M | string | (sub-property of as-path-access-lists) |
| Human-readable string that uniquely identifies an AS-path filter instance. | |||
| sequence-number | M | 0..4294967295 | |
| ”auto” | (sub-property of as-path-access-lists) | ||
| The sequence number of the as-path access-list entry, “auto” will automatically fill in the missing seq. | |||
| match-action | O | ”deny" | |
| "permit” | (sub-property of as-path-access-lists) | ||
| Decides whether a route whose AS-path matches the entry is accepted or discarded. | |||
| Default value: “permit” | |||
| as-path-set-member | O | string | (sub-property of as-path-access-lists) |
| The regular-expression pattern that the implementation applies against the received as-path string. |
Show bgp summary
Section titled “Show bgp summary”Tree Diagrams
+---x show-bgp-summary | +---w input | | +---w vrf? | | +---w (established-failed)? | | +--:(established) | | | +---w established? | | +--:(failed) | | +---w failed? | +--ro output | +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-summary | M | Path-only node, has no configurable value. | |
| Show BGP summary information. | |||
| vrf | O | ”default” | |
| vrf name | (sub-property of input) | ||
| Name of VRF instance. | |||
| established | O | empty | (sub-property of input) |
| Mutually exclusive with: |
- failed Display established neighbors. | | failed | O | empty | (sub-property of input) Mutually exclusive with:
- established
Display failed neighbors. |
| data | RO |
| (sub-property of output) |
Show bgp neighbors
Section titled “Show bgp neighbors”Tree Diagrams
+---x show-bgp-neighbors | +---w input | | +---w vrf? | | +---w address? | | +---w (info-options)? | | +--:(prefix-counts) | | | +---w prefix-counts? | | +--:(advertised-routes) | | | +---w advertised-routes? | | | +---w advertised-route-map? | | +--:(received-routes) | | | +---w received-routes? | | | +---w received-route-map? | | +--:(filtered-routes) | | | +---w filtered-routes? | | | +---w filtered-route-map? | | +--:(bestpath-routes) | | | +---w bestpath-routes? | | +--:(received-prefix-filter) | | | +---w received-prefix-filter? | | +--:(flap-statistics) | | | +---w flap-statistics? | | +--:(dampened-routes) | | | +---w dampened-routes? | | +--:(routes) | | +---w routes? | +--ro output | +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-neighbors | M | Path-only node, has no configurable value. | |
| Show BGP neighbors information. | |||
| vrf | O | ”default” | |
| vrf name | (sub-property of input) | ||
| Name of VRF instance. | |||
| address | O | A.B.C.D | |
| XX:XX:XX:XX:XX:XX:XX:XX | (sub-property of input) | ||
| Neighbor’s address. | |||
| prefix-counts | O | empty | (sub-property of input) |
| Mutually exclusive with: |
- advertised-routes
- advertised-route-map
- received-routes
- received-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- dampened-routes
- routes Display detailed prefix count information. | | advertised-routes | O | empty | (sub-property of input) Mutually exclusive with:
- prefix-counts
- received-routes
- received-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- dampened-routes
- routes Display advertised routes. | | advertised-route-map | O | string | (sub-property of input) Mutually exclusive with:
- prefix-counts
- received-routes
- received-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- dampened-routes
- routes Route-map to modify the attributes. | | received-routes | O | empty | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- dampened-routes
- routes Display received routes. | | received-route-map | O | string | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- dampened-routes
- routes Route-map to modify the attributes. | | filtered-routes | O | empty | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- received-routes
- received-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- dampened-routes
- routes Display filtered routes. | | filtered-route-map | O | string | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- received-routes
- received-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- dampened-routes
- routes Route-map to modify the attributes. | | bestpath-routes | O | empty | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- received-routes
- received-route-map
- filtered-routes
- filtered-route-map
- received-prefix-filter
- flap-statistics
- dampened-routes
- routes Display bestpath routes. | | received-prefix-filter | O | empty | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- received-routes
- received-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- flap-statistics
- dampened-routes
- routes Prefix filter to display. | | flap-statistics | O | empty | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- received-routes
- received-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- received-prefix-filter
- dampened-routes
- routes Display flap statistics. | | dampened-routes | O | empty | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- received-routes
- received-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- routes Display dampened routes. | | routes | O | empty | (sub-property of input) Mutually exclusive with:
- prefix-counts
- advertised-routes
- advertised-route-map
- received-routes
- received-route-map
- filtered-routes
- filtered-route-map
- bestpath-routes
- received-prefix-filter
- flap-statistics
- dampened-routes
Display routes. |
| data | RO |
| (sub-property of output) |
Show ip bgp
Section titled “Show ip bgp”Tree Diagrams
+---x show-ip-bgp | +---w input | | +---w vrf? | | +---w address? | | +---w (path-options)? | | +--:(bestpath) | | | +---w bestpath? | | +--:(multipath) | | +---w multipath? | +--ro output | +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-ip-bgp | M | Path-only node, has no configurable value. | |
| vrf | O | ”default” | |
| vrf name | (sub-property of input) | ||
| Name of VRF instance. | |||
| address | O | A.B.C.D | |
| XX:XX:XX:XX:XX:XX:XX:XX | (sub-property of input) | ||
| Neighbor’s address. | |||
| bestpath | O | empty | (sub-property of input) |
| Mutually exclusive with: |
- multipath Display bestpath information. | | multipath | O | empty | (sub-property of input) Mutually exclusive with:
- bestpath
Display multipath information. |
| data | RO |
| (sub-property of output) |
Show bgp community list
Section titled “Show bgp community list”Tree Diagrams
+---x show-bgp-community-list | +---w input | | +---w vrf? | | +---w (community-list)? | | +--:(number) | | | +---w number? | | +--:(name) | | +---w name? | +--ro output | +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-community-list | M | Path-only node, has no configurable value. | |
| vrf | O | ”default” | |
| vrf name | (sub-property of input) | ||
| Name of VRF instance. | |||
| number | O | 0..4294967295 | (sub-property of input) |
| Mutually exclusive with: |
- name Community list number. | | name | O | string | (sub-property of input) Mutually exclusive with:
- number
Community list name. |
| data | RO |
| (sub-property of output) |
Show bgp peer group
Section titled “Show bgp peer group”Tree Diagrams
+---x show-bgp-peer-group | +---w input | | +---w vrf? | | +---w name? | +--ro output | +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-peer-group | M | Path-only node, has no configurable value. | |
| vrf | O | ”default” | |
| vrf name | (sub-property of input) | ||
| Name of VRF instance. | |||
| name | O | string | (sub-property of input) |
| Peer group name. | |||
| data | RO | (sub-property of output) |
Show bgp statistics
Section titled “Show bgp statistics”Tree Diagrams
+---x show-bgp-statistics | +---w input | | +---w vrf? | +--ro output | +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-statistics | M | Path-only node, has no configurable value. | |
| vrf | O | ”default” | |
| vrf name | (sub-property of input) | ||
| Name of VRF instance. | |||
| data | RO | (sub-property of output) |
Show bgp l2vpn evpn
Section titled “Show bgp l2vpn evpn”Tree Diagrams
+---x show-bgp-l2vpn-evpn | +---w input | | +---w vrf? | +--ro output | +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-l2vpn-evpn | M | Path-only node, has no configurable value. | |
| vrf | O | ”default” | |
| vrf name | (sub-property of input) | ||
| Name of VRF instance. | |||
| data | RO | (sub-property of output) |
Show evpn vni
Section titled “Show evpn vni”Tree Diagrams
+---x show-evpn-vni | +---w input | | +---w vni? | +--ro output | +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-evpn-vni | M | Path-only node, has no configurable value. | |
| vni | O | 0..4294967295 | (sub-property of input) |
| VNI number. | |||
| data | RO | (sub-property of output) |
Show bgp vrf all
Section titled “Show bgp vrf all”Tree Diagrams
+---x show-bgp-vrf-all +--ro output +--ro data?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-vrf-all | M | Path-only node, has no configurable value. | |
| data | RO | (sub-property of output) |