.. _router_bgp_neighbor: router bgp neighbor =================== Specify a neighbor router neighbor Specification ---------------------- ===================================== ======================================================================== **Parameter** **Value** ===================================== ======================================================================== **Type** *Intermediate Resource* **Element Name** neighbor **Element URI** /axapi/v3/router/bgp/{as-number}/neighbor **Element Attributes** neighbor_attributes **Partition Visibility** shared **Schema** :download:`neighbor schema ` ===================================== ======================================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/router/bgp/{as-number}/neighbor .. raw:: html neighbor_attributes .. raw:: html
.. _2507_neighbor_attributes: neighbor attributes ------------------- **ethernet-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/ethernet-neighbor/{ethernet} ` **ipv4-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/ipv4-neighbor/{neighbor-ipv4} ` **ipv6-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/ipv6-neighbor/{neighbor-ipv6} ` **peer-group-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group} ` **trunk-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/trunk-neighbor/{trunk} ` **ve-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/ve-neighbor/{ve} ` .. _2507_ve-neighbor-list: ve-neighbor-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **peer-group-name** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **unnumbered** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve** **Description** Virtual ethernet interface number **Type:** number **Format:** interface .. _2507_ipv4-neighbor-list: ipv4-neighbor-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acos-application-only** **Description** Send BGP update to ACOS application **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **advertisement-interval** **Description** Minimum interval between sending BGP routing updates (time in seconds) **Type:** number **Range:** 1-600 **Mutual Exclusion:** advertisement-interval and peer-group-name are mutually exclusive **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **as-origination-interval** **Description** Minimum interval between sending AS-origination routing updates (time in seconds) **Type:** number **Range:** 1-600 **Mutual Exclusion:** as-origination-interval and peer-group-name are mutually exclusive **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bfd-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **bfd-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **collide-established** **Description** Include Neighbor in Established State for Collision Detection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connect** **Description** BGP connect timer **Type:** number **Range:** 1-65535 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** default-originate and peer-group-name are mutually exclusive **description** **Description** Neighbor specific description (Up to 80 characters describing this neighbor) **Type:** string **Format:** string-rlx **Maximum Length:** 80 characters **Maximum Length:** 1 characters **disallow-infinite-holdtime** **Description** BGP per neighbor disallow-infinite-holdtime **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disallow-infinite-holdtime and peer-group-name are mutually exclusive **distribute-lists** **Type:** List **dont-capability-negotiate** **Description** Do not perform capability negotiation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamic** **Description** Advertise dynamic capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop** **Description** Allow EBGP neighbors not on directly connected networks **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop-hop-count** **Description** maximum hop count **Type:** number **Range:** 1-255 **enforce-multihop** **Description** Enforce EBGP neighbors to perform multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** ethernet,update-source-ip, update-source-ipv6, loopback, ve, trunk, lif, and tunnel are mutually exclusive **graceful-restart** **Description** enable graceful-restart helper for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **key-id** **Description** Key ID **Type:** number **Range:** 0-255 **key-type** **Description** 'md5': md5; 'meticulous-md5': meticulous-md5; 'meticulous-sha1': meticulous-sha1; 'sha1': sha1; 'simple': simple; (Keyed MD5/Meticulous Keyed MD5/Meticulous Keyed SHA1/Keyed SHA1/Simple Password) **Type:** string **Supported Values:** md5, meticulous-md5, meticulous-sha1, sha1, simple **lif** **Description** Logical interface (Lif interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **Mutual Exclusion:** lif,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and tunnel are mutually exclusive **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** loopback,update-source-ip, update-source-ipv6, ethernet, ve, trunk, lif, and tunnel are mutually exclusive **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **multihop** **Description** Enable multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **nbr-remote-as** **Description** Specify AS number of BGP neighbor **Type:** string **Maximum Length:** 11 characters **Maximum Length:** 1 characters **neighbor-filter-lists** **Type:** List **neighbor-ipv4** **Description** Neighbor address **Type:** string **Format:** ipv4-address **neighbor-prefix-lists** **Type:** List **neighbor-route-map-lists** **Type:** List **next-hop-self** **Description** Disable the next hop calculation for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** next-hop-self and peer-group-name are mutually exclusive **override-capability** **Description** Override capability negotiation result **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pass-encrypted** **Description** **pass-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 80 characters **Maximum Length:** 1 characters **passive** **Description** Don't send open messages to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group-name** **Description** Configure peer-group (peer-group name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** peer-group-name,advertisement-interval, as-origination-interval, default-originate, disallow-infinite-holdtime, next-hop-self, timers, and unsuppress-map are mutually exclusive **prefix-list-direction** **Description** 'both': both; 'receive': receive; 'send': send; **Type:** string **Supported Values:** both, receive, send **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **restart-min** **Description** restart value, 1 to 1440 minutes **Type:** number **Range:** 1-1440 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **route-refresh** **Description** Advertise route-refresh capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **send-community-val** **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; **Type:** string **Supported Values:** all, both, none, standard, extended, large **Default:** both **shutdown** **Description** Administratively shut down this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **strict-capability-match** **Description** Strict capability negotiation match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **telemetry** **Description** Send BGP update to telemetry db **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timers-holdtime** **Description** Holdtime **Type:** number **Range:** 0-65535 **Default:** 90 **timers-keepalive** **Description** Keepalive interval **Type:** number **Range:** 0-65535 **Default:** 30 **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **Mutual Exclusion:** trunk,update-source-ip, update-source-ipv6, ethernet, loopback, ve, lif, and tunnel are mutually exclusive **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **Mutual Exclusion:** tunnel,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and lif are mutually exclusive **unsuppress-map** **Description** Route-map to selectively unsuppress suppressed routes (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** unsuppress-map and peer-group-name are mutually exclusive **update-source-ip** **Description** IP address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** update-source-ip,update-source-ipv6, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive **update-source-ipv6** **Description** IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** update-source-ipv6,update-source-ip, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface **Mutual Exclusion:** ve,update-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif, and tunnel are mutually exclusive **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _2507_ipv4-neighbor-list_distribute-lists: ipv4-neighbor-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distribute-list** **Description** Filter updates to/from this neighbor (IP standard/extended/named access list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distribute-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _2507_ipv4-neighbor-list_neighbor-route-map-lists: ipv4-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _2507_ipv4-neighbor-list_neighbor-filter-lists: ipv4-neighbor-list_neighbor-filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Description** Establish BGP filters (AS path access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **filter-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _2507_ipv4-neighbor-list_neighbor-prefix-lists: ipv4-neighbor-list_neighbor-prefix-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-prefix-list** **Description** Filter updates to/from this neighbor (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **nbr-prefix-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _2507_peer-group-neighbor-list: peer-group-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **advertisement-interval** **Description** Minimum interval between sending BGP routing updates (time in seconds) **Type:** number **Range:** 1-600 **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **as-origination-interval** **Description** Minimum interval between sending AS-origination routing updates (time in seconds) **Type:** number **Range:** 1-600 **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **collide-established** **Description** Include Neighbor in Established State for Collision Detection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connect** **Description** BGP connect timer **Type:** number **Range:** 1-65535 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **description** **Description** Neighbor specific description (Up to 80 characters describing this neighbor) **Type:** string **Format:** string-rlx **Maximum Length:** 80 characters **Maximum Length:** 1 characters **dont-capability-negotiate** **Description** Do not perform capability negotiation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamic** **Description** Advertise dynamic capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop** **Description** Allow EBGP neighbors not on directly connected networks **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop-hop-count** **Description** maximum hop count **Type:** number **Range:** 1-255 **enforce-multihop** **Description** Enforce EBGP neighbors to perform multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** ethernet,update-source-ip, update-source-ipv6, loopback, ve, trunk, lif, and tunnel are mutually exclusive **extended-nexthop** **Description** Advertise extended-nexthop capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **lif** **Description** Logical interface (Lif interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **Mutual Exclusion:** lif,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and tunnel are mutually exclusive **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** loopback,update-source-ip, update-source-ipv6, ethernet, ve, trunk, lif, and tunnel are mutually exclusive **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **multihop** **Description** Enable multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **neighbor-route-map-lists** **Type:** List **override-capability** **Description** Override capability negotiation result **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pass-encrypted** **Description** **pass-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 80 characters **Maximum Length:** 1 characters **passive** **Description** Don't send open messages to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group** **Description** Neighbor tag **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **peer-group-key** **Description** Configure peer-group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group-remote-as** **Description** Specify AS number of BGP neighbor **Type:** string **Maximum Length:** 11 characters **Maximum Length:** 1 characters **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **route-refresh** **Description** Advertise route-refresh capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **shutdown** **Description** Administratively shut down this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **strict-capability-match** **Description** Strict capability negotiation match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timers-holdtime** **Description** Holdtime **Type:** number **Range:** 0-65535 **Default:** 90 **timers-keepalive** **Description** Keepalive interval **Type:** number **Range:** 0-65535 **Default:** 30 **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **Mutual Exclusion:** trunk,update-source-ip, update-source-ipv6, ethernet, loopback, ve, lif, and tunnel are mutually exclusive **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **Mutual Exclusion:** tunnel,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and lif are mutually exclusive **update-source-ip** **Description** IP address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** update-source-ip,update-source-ipv6, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive **update-source-ipv6** **Description** IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** update-source-ipv6,update-source-ip, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface **Mutual Exclusion:** ve,update-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif, and tunnel are mutually exclusive **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _2507_peer-group-neighbor-list_neighbor-route-map-lists: peer-group-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _2507_ipv6-neighbor-list: ipv6-neighbor-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acos-application-only** **Description** Send BGP update to ACOS application **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **advertisement-interval** **Description** Minimum interval between sending BGP routing updates (time in seconds) **Type:** number **Range:** 1-600 **Mutual Exclusion:** advertisement-interval and peer-group-name are mutually exclusive **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **as-origination-interval** **Description** Minimum interval between sending AS-origination routing updates (time in seconds) **Type:** number **Range:** 1-600 **Mutual Exclusion:** as-origination-interval and peer-group-name are mutually exclusive **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bfd-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **bfd-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **collide-established** **Description** Include Neighbor in Established State for Collision Detection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connect** **Description** BGP connect timer **Type:** number **Range:** 1-65535 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** default-originate and peer-group-name are mutually exclusive **description** **Description** Neighbor specific description (Up to 80 characters describing this neighbor) **Type:** string **Format:** string-rlx **Maximum Length:** 80 characters **Maximum Length:** 1 characters **disallow-infinite-holdtime** **Description** BGP per neighbor disallow-infinite-holdtime **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disallow-infinite-holdtime and peer-group-name are mutually exclusive **distribute-lists** **Type:** List **dont-capability-negotiate** **Description** Do not perform capability negotiation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamic** **Description** Advertise dynamic capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop** **Description** Allow EBGP neighbors not on directly connected networks **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop-hop-count** **Description** maximum hop count **Type:** number **Range:** 1-255 **enforce-multihop** **Description** Enforce EBGP neighbors to perform multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** ethernet,update-source-ip, update-source-ipv6, loopback, ve, trunk, lif, and tunnel are mutually exclusive **extended-nexthop** **Description** Advertise extended-nexthop capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **graceful-restart** **Description** enable graceful-restart helper for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **key-id** **Description** Key ID **Type:** number **Range:** 0-255 **key-type** **Description** 'md5': md5; 'meticulous-md5': meticulous-md5; 'meticulous-sha1': meticulous-sha1; 'sha1': sha1; 'simple': simple; (Keyed MD5/Meticulous Keyed MD5/Meticulous Keyed SHA1/Keyed SHA1/Simple Password) **Type:** string **Supported Values:** md5, meticulous-md5, meticulous-sha1, sha1, simple **lif** **Description** Logical interface (Lif interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **Mutual Exclusion:** lif,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and tunnel are mutually exclusive **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** loopback,update-source-ip, update-source-ipv6, ethernet, ve, trunk, lif, and tunnel are mutually exclusive **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **multihop** **Description** Enable multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **nbr-remote-as** **Description** Specify AS number of BGP neighbor **Type:** string **Maximum Length:** 11 characters **Maximum Length:** 1 characters **neighbor-filter-lists** **Type:** List **neighbor-ipv6** **Description** Neighbor IPv6 address **Type:** string **Format:** ipv6-address **neighbor-prefix-lists** **Type:** List **neighbor-route-map-lists** **Type:** List **next-hop-self** **Description** Disable the next hop calculation for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** next-hop-self and peer-group-name are mutually exclusive **override-capability** **Description** Override capability negotiation result **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pass-encrypted** **Description** **pass-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 80 characters **Maximum Length:** 1 characters **passive** **Description** Don't send open messages to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group-name** **Description** Configure peer-group (peer-group name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** peer-group-name,advertisement-interval, as-origination-interval, default-originate, disallow-infinite-holdtime, next-hop-self, timers, and unsuppress-map are mutually exclusive **prefix-list-direction** **Description** 'both': both; 'receive': receive; 'send': send; **Type:** string **Supported Values:** both, receive, send **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **restart-min** **Description** restart value, 1 to 1440 minutes **Type:** number **Range:** 1-1440 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **route-refresh** **Description** Advertise route-refresh capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **send-community-val** **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; **Type:** string **Supported Values:** all, both, none, standard, extended, large **Default:** both **shutdown** **Description** Administratively shut down this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **strict-capability-match** **Description** Strict capability negotiation match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **telemetry** **Description** Send BGP update to telemetry db **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timers-holdtime** **Description** Holdtime **Type:** number **Range:** 0-65535 **Default:** 90 **timers-keepalive** **Description** Keepalive interval **Type:** number **Range:** 0-65535 **Default:** 30 **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **Mutual Exclusion:** trunk,update-source-ip, update-source-ipv6, ethernet, loopback, ve, lif, and tunnel are mutually exclusive **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **Mutual Exclusion:** tunnel,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and lif are mutually exclusive **unsuppress-map** **Description** Route-map to selectively unsuppress suppressed routes (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** unsuppress-map and peer-group-name are mutually exclusive **update-source-ip** **Description** IP address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** update-source-ip,update-source-ipv6, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive **update-source-ipv6** **Description** IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** update-source-ipv6,update-source-ip, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface **Mutual Exclusion:** ve,update-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif, and tunnel are mutually exclusive **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _2507_ipv6-neighbor-list_distribute-lists: ipv6-neighbor-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distribute-list** **Description** Filter updates to/from this neighbor (IP standard/extended/named access list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distribute-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _2507_ipv6-neighbor-list_neighbor-route-map-lists: ipv6-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _2507_ipv6-neighbor-list_neighbor-filter-lists: ipv6-neighbor-list_neighbor-filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Description** Establish BGP filters (AS path access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **filter-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _2507_ipv6-neighbor-list_neighbor-prefix-lists: ipv6-neighbor-list_neighbor-prefix-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-prefix-list** **Description** Filter updates to/from this neighbor (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **nbr-prefix-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _2507_ethernet-neighbor-list: ethernet-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface number **Type:** number **Format:** interface **peer-group-name** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **unnumbered** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2507_trunk-neighbor-list: trunk-neighbor-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **peer-group-name** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **trunk** **Description** Trunk interface number **Type:** number **Format:** interface **unnumbered** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters