BGPNeighbor

None

Overview

associatedExportRoutingPolicyID string filterable  
associatedImportRoutingPolicyID string filterable  
BFDEnabled boolean filterable  
dampeningEnabled boolean filterable   orderable  
description string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
IPType enum (IPV4 | IPV6) filterable   orderable  
IPv6Address string filterable   orderable  
name string required   filterable   orderable  
peerAS integer required   filterable   orderable  
peerIP string filterable   orderable  
session string

API Resource

/bgpneighbors/id
delete get put

Parents

/vports/id/bgpneighbors
get post
/subnets/id/bgpneighbors
get post
/bgpneighbors
get
/vlans/id/bgpneighbors
get post

Children

/bgpneighbors/id/metadatas
get post
/bgpneighbors/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedExportRoutingPolicyID string filterable  
Discussion

export policy ID


Charateristics

Format: free
SDK attribute: associatedExportRoutingPolicyID

associatedImportRoutingPolicyID string filterable  
Discussion

import routing policy ID


Charateristics

Format: free
SDK attribute: associatedImportRoutingPolicyID

BFDEnabled boolean filterable  
Discussion

Enable or disable Bidirectional Forwarding Detection for this BGP neighbor


Charateristics

Default value: false
SDK attribute: BFDEnabled

dampeningEnabled boolean filterable   orderable  
Discussion

Enable/disable route flap damping.


Charateristics

SDK attribute: dampeningEnabled

description string
Discussion

Short description for this peer


Charateristics

Format: free
SDK attribute: description

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

IPType enum filterable   orderable  
Discussion

It can be either IPv4 or IPv6


Charateristics

Allowed values: IPV4, IPV6
Default value: IPV4
SDK attribute: IPType

IPv6Address string filterable   orderable  
Discussion

Peer IPv6 address


Charateristics

Format: free
SDK attribute: IPv6Address

name string required   filterable   orderable  
Discussion

Name of the peer


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

peerAS integer required   filterable   orderable  
Discussion

Local autonomous system to be used when establishing a session with the remote peer if it is different from the global BGP router autonomous system number.


Charateristics

Min value: 1
Max value: 65535
SDK attribute: peerAS

peerIP string filterable   orderable  
Discussion

IP Address of the neighbor. If the neighbor is attached to a host vPort this is optional or must be the same as the host's IP. For uplink or bridge vPort neighbors the IP address must be specified


Charateristics

Format: free
Max length: 255
SDK attribute: peerIP

session string
Discussion

neighbor session yang blob


Charateristics

Format: free
SDK attribute: session