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 schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/

peer-group-neighbor Attributes

Create List

POST

/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/

peer-group-neighbor Attributes

Get Object

GET

/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group}

peer-group-neighbor Attributes

Get List

GET

/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/

peer-group-neighbor-list

Modify Object

POST

/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group}

peer-group-neighbor Attributes

Replace Object

PUT

/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group}

peer-group-neighbor Attributes

Replace List

PUT

/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/

peer-group-neighbor-list

Delete Object

DELETE

/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group}

peer-group-neighbor Attributes

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

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

disallow-infinite-holdtime

Description: BGP per neighbor disallow-infinite-holdtime

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

distribute-lists

Description: distribute-lists is a JSON List . Please see below for 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 and lif are mutually exclusive

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 number)

Type: number

Range: 1-128

Mutual Exclusion: lif update-source-ip, update-source-ipv6, ethernet, loopback, ve and trunk 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 and lif 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

Range: 1-65536

maximum-prefix-thres

Description: threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for neighbor-filter-lists

Type: List

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for 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

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

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

Required: Yes

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

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: trunk update-source-ip, update-source-ipv6, ethernet, loopback, ve and lif are mutually exclusive

unsuppress-map

Description: Route-map to selectively unsuppress suppressed routes (Name of route map)

Type: string

update-source-ip

Description: IP address

Type: string

Format: ipv4-address

Mutual Exclusion: update-source-ip update-source-ipv6, ethernet, loopback, ve, trunk and lif 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 and lif are mutually exclusive

uuid

Description: uuid of the object

Type: string

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 and lif 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

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

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

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

filter-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out