BGPNeighbor

Virtual Cloud Services (VCS) in the data center BGP PE-CE is configured at vport level . Network Service Gateways (NSG) BGP is configured at subnet level.

Overview

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

API Resource

/bgpneighbors/id
delete get put

Parents

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

Children

/bgpneighbors/id/deploymentfailures
get post
/bgpneighbors/id/permissions
delete get post put
/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

domainServiceLabel string filterable   orderable  
Discussion

Service ID or external label given to Domain

Charateristics

Format: free
Min length: 1
Max length: 32
SDK attribute: domainServiceLabel

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

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
Discussion

It can be either IPv4 or IPv6

Charateristics

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

IPv6Address string
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

Autonomous System (AS) value 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

peerConfiguration string
Discussion

BGP Peer session configuration and default policies.

Charateristics

SDK attribute: peerConfiguration

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