router bgp neighbor peer-group-neighbor¶
Specify a peer-group neighbor router
peer-group-neighbor Specification¶
Type Collection Object Key(s) peer-group Collection Name peer-group-neighbor-list Collection URI /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor Element Name peer-group-neighbor Element URI /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group} Element Attributes peer-group-neighbor_attributes Schema peer-group-neighbor schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor | ||
Create List | POST | /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor | ||
Get Object | GET | /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group} | ||
Get List | GET | /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor | ||
Modify Object | POST | /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group} | ||
Replace Object | PUT | /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group} | ||
Replace List | PUT | /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor | ||
Delete Object | DELETE | /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group} |
peer-group-neighbor-list¶
peer-group-neighbor-list is JSON List of peer-group-neighbor attributes
peer-group-neighbor-list : [
]
peer-group-neighbor attributes¶
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
disallow-infinite-holdtime
Description BGP per neighbor disallow-infinite-holdtime
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
distribute-lists
Type: Listdont-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: ethernetupdate-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: lifupdate-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: loopbackupdate-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-filter-lists
Type: Listneighbor-prefix-lists
Type: Listneighbor-route-map-lists
Type: Listnext-hop-self
Description Disable the next hop calculation for this neighbor
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
override-capability
Description Override capability negotiation result
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pass-encrypted
Descriptionpass-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: number
Range: 1-4294967295
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
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: both, none, standard, extended
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
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: trunkupdate-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: tunnelupdate-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
update-source-ip
Description IP address
Type: string
Format: ipv4-address
Mutual Exclusion: update-source-ipupdate-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-ipv6update-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: veupdate-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
distribute-lists¶
Specification 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
neighbor-route-map-lists¶
Specification 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
neighbor-prefix-lists¶
Specification 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
neighbor-filter-lists¶
Specification 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