| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| acceptOrf |
Specifies Enable/disable acceptance of Outbound route filtering
type=generic.TruthValue default=false Displayed(tab/group)=Accept ORF (ORF Extended Community) |
| advertise |
Specifies whether to enable/disable Advertise.
type=boolean default=false Displayed(tab/group)=Advertise (Behavior/BFD Strict Mode) |
| advertiseInactiveRts |
type=generic.TruthValue default=false Displayed(tab/group)=Advertise Inactive Routes (Behavior) |
| advertiseIpv6NhFamily |
The value of advertiseIpv6NhFamily specifies the types of AFI/SAFI the SROS BGP peer supports extended next-hop encoding and resolution.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Advertise IPv6 NextHop Family (Behavior) |
| advertiseLabel |
DEPRECATED: 14.0R4 - OBSOLETE: No more Supported. type=bgp.AdvLabelAddressFamily default=none Displayed(tab/group)=Advertise Label (VPN/VPN) |
| advertiseLdpPrefix |
Specifies whether all the activated LDP FEC prefixes will be sent to remote BGP peer to support stitching of an LDP FEC to a BGP labeled route.
type=generic.TruthValue default=false Displayed(tab/group)=Advertise LDP Prefix (VPN/VPN) |
| aggregatorIdZero |
Set the router ID in the BGP aggregator path attribute to zero.
Doing this prevents different routers within an AS from creating
aggregate routes that contain different AS paths.
type=generic.TruthValue default=false Displayed(tab/group)=Aggregator ID Zero (Behavior) |
| aigp |
The value of aigp specifies whether Accumulated IGP (AIGP) path attribute support is enabled on
this bgp peer.
type=generic.TruthValue default=false Displayed(tab/group)=Accumulated IGP (Behavior) |
| allowLocFallback |
Decides what the system should do when the BGP next-hop is not reachable in the TE-DB for the
configured ORR location, tBgpPeerORRLocation. If the value is set to 'true', then next-hop
cost calculation and best-path selection default back to the location of the route-reflector in the network.
If the value is set to 'false', then no routes are advertised to the client(s).
type=boolean default=false Displayed(tab/group)=Allow Local Fallback |
| bfdEnabled |
specifies whether Bi-directional Forwarding Detection is enabled on this
BGP peer . When the value is 'true', this BGP peer can establish BFD sessions
and use BFD as a signalling mechanism. When it is 'false', it cannot
use BFD.
type=generic.TruthValue default=false Displayed(tab/group)=BFD Enabled (Behavior) |
| bgp.Md5Key-Set |
type=Children-Set |
| bgp.PeerAddPath-Set |
type=Children-Set |
| bgp.PeerExportPolicy-Set |
type=Children-Set |
| bgp.PeerImportPolicy-Set |
type=Children-Set |
| bgp.PeerLongLivedGracefulRestart-Set |
type=Children-Set |
| bgp.PeerNeighborSRv6-Set |
type=Children-Set |
| bgp.PeerSendOrfRouteTargetEntry-Set |
type=Children-Set |
| bgp.PrefixLimit-Set |
type=Children-Set |
| bgpPeerNgBlockPrefixSid |
It enables or disables sending of the prefix SID attribute.
type=boolean default=false Displayed(tab/group)=Block Prefix SID (Behavior) |
| bgpSelectiveDownload |
It specifies whether to enable/disable selective download of label-ipv4 routes
type=boolean default=false Displayed(tab/group)=Selective Download (Behavior) |
| bmp.Monitor-Set |
type=Children-Set |
| byPassMRAITimer |
The value of byPassMRAITimer specifies whether the Bgp
instance is configured to send out the BGP update immediately after
the session comes up, without waiting for Minimum Route Advertisement
Interval, minRouteAdvertisement, to countdown to zero.
If the value is set to 'true', minRouteAdvertisement's value
is disregarded and BGP updates are sent out immediately after the
session comes up.
If the value is set to 'false', the system waits for
minRouteAdvertisement's full value to countdown before
sending out the BGP updates after the session comes up.
type=generic.TruthValue default=false Displayed(tab/group)=ByPass MRAI Timer (Behavior) |
| clusterId |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Cluster ID |
| connectRetryTime |
Set the value (in seconds) of the BGP Connect Retry timer.
type=int default=120 minimum=1 maximum=65535 units=seconds Displayed(tab/group)=Connect Retry Time (Behavior) |
| connectionState |
type=int access=read-only default=idle Displayed(tab/group)=Connection State (/States) enums= 0: notApplicable - N/A 1: idle - Idle 2: connect - Connect 3: active - Active 4: opensent - Open Sent 5: openconfirm - Open Confirm 6: established - Established |
| convergenceEORReceived |
specifies the types of AFI/SAFI for which the EOR marker was received.
type=bgp.IpFamilyMask access=read-only Displayed(tab/group)=EOR Received (Behavior/Convergence) |
| convergenceEORSent |
specifies the types of AFI/SAFI for which the EOR marker was sent.
type=bgp.IpFamilyMask access=read-only Displayed(tab/group)=EOR Sent (Behavior/Convergence) |
| convergenceExceededMinWait |
indicates establishment of session relative to tBgpInstanceConvMinWaitToAdv timer.
type=int access=read-only Displayed(tab/group)=Exceeded Min Wait (Behavior/Convergence) enums= 1: no - No 2: yes - Yes 3: unknown - Unknown |
| creationOrigin |
type=svt.L2RouteOriginType access=read-create default=manual |
| customProperties |
This is used for any custom properties for this objects.
type=Map (string to string) |
| dampOscErrorInterval |
Specifies the time in minutes after a session reset, during which the session must be error-free in order
to reset the penalty counter and return idle-hold-time to dampOscInitialWaitTime.
type=long default=30 minimum=0 maximum=2048 units=minutes Displayed(tab/group)=Error Interval (Behavior/Damp Peer Oscillations) |
| dampOscInitialWaitTime |
Specifies the time in minutes, that a session remains in the idle-state after it has been stable for a while.
type=long default=0 minimum=0 maximum=2048 units=minutes Displayed(tab/group)=Initial Wait Time (Behavior/Damp Peer Oscillations) |
| dampOscMaxWaitTime |
Specifies the maximum amount of time in minutes, that the session remains in the idle-state after it
has experienced repeated instability.
type=long default=60 minimum=1 maximum=2048 units=minutes Displayed(tab/group)=Maximum Wait Time (Behavior/Damp Peer Oscillations) |
| dampOscSecondWaitTime |
Specifies the time in minutes, that is doubled after each repeated session failure that
occurs within a relatively short span of time.
type=long default=5 minimum=1 maximum=2048 units=minutes Displayed(tab/group)=Second Wait Time (Behavior/Damp Peer Oscillations) |
| dampPeerOscillations |
type=generic.TruthValue default=false Displayed(tab/group)=Enable Damp Peer Oscillations (Behavior/Damp Peer Oscillations) |
| damping |
Determines whether route dampening should be applied to learned routes.
type=generic.TruthValue default=false Displayed(tab/group)=Damping (Behavior) |
| defaultOriginate |
specifies the types of AFI/SAFI for which SROS BGP will originate default route independent
of the RTM default route
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Send Default (Behavior/Default Originate) |
| defaultRouteTarget |
Specifies whether to send the default Route Target Constraint (RTC) route to this BGP peer.
type=generic.TruthValue default=false Displayed(tab/group)=Default Route Target (Behavior) |
| defaultRxEvpnEncapType |
Specifies how BGP will treat a received EVPN route without BGP encapsulation
extended community. If no encapsulation is received, BGP will validate the route as MPLS or VXLAN depending
on the the value of defaultEvpnEncapType
type=bgp.DefaultRxEVPNEncap default=mpls Displayed(tab/group)=Default Received EVPN Encap Type (Behavior) |
| disable4ByteASN |
type=generic.TruthValue default=false Displayed(tab/group)=Disable 4Byte ASN (AS Properties) |
| disableCapabilityNegotiation |
Specifies whether capability negotiation is disabled for this peer.
type=generic.TruthValue default=false Displayed(tab/group)=Disable Capability Negotiation (Behavior) |
| disableClientReflect |
type=generic.TruthValue default=false Displayed(tab/group)=Disable Client Reflect (Behavior) |
| disableComms |
type=generic.TruthValue default=false Displayed(tab/group)=Disable Standard Communities (Behavior) |
| disableExtComms |
type=generic.TruthValue default=false Displayed(tab/group)=Disable Extended Communities (Behavior) |
| disableLargeComms |
The value of this enables or disables sending of community attribute to the peer for large communities.
type=generic.TruthValue default=false Displayed(tab/group)=Disable Large Communities (Behavior) |
| dropRoutes |
Specifies whether to drop routes with srv6 tlvs for this peer of BGP group
type=boolean default=false Displayed(tab/group)=Enable Drop Routes (Segment Routing V6) |
| eBgpPeerNgLabelPreference |
The value of eBgpPeerNgLabelPreference specifies the route
preference for label-IPv4 and label-IPv6 ebgp routes.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Egress Label BGP (Behavior/Default Route Preference) |
| eBgpPeerNgPreference |
The value of eBgpPeerNgPreference specifies the route preference
for ebgp routes.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Egress BGP (Behavior/Default Route Preference) |
| eBgpRejectPolicyExport |
The value eBgpRejectPolicyExport enables or disables if policies can be exported.
type=generic.TruthValue default=false Displayed(tab/group)=Export (Behavior/EBGP Default Reject Policy) |
| eBgpRejectPolicyImport |
The value eBgpRejectPolicyImport enables or disables if policies can be imported.
type=generic.TruthValue default=false Displayed(tab/group)=Import (Behavior/EBGP Default Reject Policy) |
| ebgpLinkBandwidth |
The value of this property specifies the address families of the routes received from a single-hop EBGP neighbor,
for which a Link Bandwidth Extended Community with static AS and bandwidth values is added.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=EBGP Link Bandwidth (Behavior/Link Bandwidth) |
| ebgpLinkBandwidthAccept |
Specifies the address families of the routes received from a single-hop EBGP neighbor, for
which a Link Bandwidth Extended Community with static AS and bandwidth values is allowed.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Accept from EBGP (Behavior/Link Bandwidth) |
| ebgpLinkBandwidthAggregatePaths |
Specifies the families of the routes for which aggregate bandwidth is supported
for a re-advertising router.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Aggregate Used Paths (Behavior/Link Bandwidth) |
| ebgpLinkBandwidthSend |
Specifies the address families of the routes sent to a single-hop EBGP neighbor, for
which a Link Bandwidth Extended Community with static AS and bandwidth values is allowed.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Send to EBGP (Behavior/Link Bandwidth) |
| egressPeerEngAdminState |
Specifies the desired administrative state of Egress Engineering for this BGP instance.
type=int default=3 Displayed(tab/group)=Administrative State (Behavior/Egress Peer Engineering) enums= 2: up - Up 3: down - Down |
| egressPeerEngLabelUnicast |
Specifies whether to originate label unicast route on this peer of BGP.
type=boolean default=false Displayed(tab/group)=Egress Peer Engineering Label Unicast (Behavior/Egress Peer Engineering) |
| egressPeerEngineering |
Specifies whether to enable/disable egress peer engineering.
type=boolean default=false Displayed(tab/group)=Egress Peer Engineering (Behavior/Egress Peer Engineering) |
| enableAddPath |
This is a NFM-P only attribute to enable configure/deletion of Add Path configurations through NFM-P GUI only.
type=boolean default=false Displayed(tab/group)=Enable Add-Path (Add Path) |
| enableBgpMonitoring |
type=boolean Displayed(tab/group)=Enable Monitoring (BMP) |
| enableOrf |
specifies Enable/disable outbound route filtering capability for the BGP instance
type=generic.TruthValue default=false |
| enabledPeerTracking |
type=generic.TruthValue default=false Displayed(tab/group)=Enable Peer Tracking (Behavior) |
| enforceFirstAs |
Specifies whether the receipt of BGP routes from an eBGP neighbor should be classified as an error
when it has an AS-Path with the most recent AS not matching the configured peer-as of the neighbor.
If the value is set to 'true', the most recent AS number in the AS-Path will be checked for every received
route from the peer or set of peers to match the peer's configured peer-as. If it does not match, then the
session will be reset if the update-fault-tolerance under error-handling is not configured. Else, the session
will not be reset, but all the prefixes in the received update will be treated as withdrawn and logged.
type=generic.TruthValue default=false Displayed(tab/group)=Enforce First AS (Behavior) |
| evpnAddPathLimit |
Specifies the maximum number of paths per EVPN prefix that can be advertised to ADD-PATH peers
on this BGP peer
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=EVPN Add-Path Limit (Behavior/Add-Path) |
| evpnLinkBWAddToRcvdBgp |
Specifies whether a weight is internally added to the received PE-CE BGP routes in the
VPRN and what that weight is on this peer of BGP.
For the purpose of unequal ECMP, if EVPN-IFL and BGP PE-CE routes are
combined into the same ECMP set and the value is in the range of
[1..128], the configured weight is added to all BGP PE-CE routes.
When the value is set to -1, ECMP set resulting from combining
EVPN-IFL and BGP PE-CE route will fallback to unweighted ECMP"
type=long default=-1 minimum=-1 maximum=128 Displayed(tab/group)=Add to Received BGP (Behavior/EVPN Link Bandwidth) |
| extCommsOrf |
specifies if outbound route filtering capability is based on extended communities
type=generic.TruthValue default=false |
| extendedNhEncoding |
The value of extendedNhEncoding specifies the types of AFI/SAFI the Bgp peer is configured to support extended next-hop encoding.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Extended NextHop Encoding (Behavior) |
| family |
type=bgp.IpFamilyMask default=ipv4 Displayed(tab/group)=Family (VPN/VPN) |
| fastExtFailover |
type=generic.TruthValue default=false Displayed(tab/group)=Disable Fast External Failover (Behavior) |
| faultTolerance |
type=generic.TruthValue default=false Displayed(tab/group)=Fault Tolerance (Behavior/Error Handling) |
| flowSpecValidate |
specifies whether validation of received flow specification routes is enabled on this BGP peer.
From SR 15.0R1, this attribute is deprecated. Use bgpSite.flowSpecValidate instead.
DEPRECATED: 17.3 - No longer supported on SR 15.0R1. Use bgp.Site.flowSpecValidate instead. type=generic.TruthValue default=false Displayed(tab/group)=FlowSpec Validate Enabled (Behavior) |
| grRestartNotification |
type=generic.TruthValue default=false Displayed(tab/group)=Enable Notification (Graceful Restart) |
| grRestartTime |
Specifies the maximum amount of time in seconds that a graceful restart should take.
type=long default=300 minimum=0 maximum=4095 units=seconds Displayed(tab/group)=Restart Time (Graceful Restart) |
| gracefulRestart |
type=generic.TruthValue default=false Displayed(tab/group)=Graceful Restart (Graceful Restart) |
| holdTime |
type=int default=90 minimum=0 maximum=65535 units=seconds Displayed(tab/group)=Hold Time (Behavior/Hold Time) |
| holdTimeBfdStrictMode |
Specifies the desired hold time of bfd-strict-mode for bgp peer.
type=int default=30 minimum=1 maximum=65535 units=seconds Displayed(tab/group)=Hold Time (Behavior/BFD Strict Mode) |
| holdTimeIsStrict |
type=generic.TruthValue default=false Displayed(tab/group)=Strict (Behavior/Hold Time) |
| iBgpPeerNgLabelPreference |
The value of iBgpPeerNgLabelPreference specifies the route
preference for label-IPv4 and label-IPv6 ibgp routes.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Ingress Label BGP (Behavior/Default Route Preference) |
| iBgpPeerNgPreference |
The value of iBgpPeerNgPreference specifies the route preference
for ibgp routes.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Ingress BGP (Behavior/Default Route Preference) |
| inheritanceMask |
For each object in this row, controls whether to
inherit the operational value of an object,
or use the administratively set value. When the bit for an object is set to one, then the
object's administrative and operational value are whatever
the attributes value is or most recently SET value is.
When the bit for an object is set to zero, then the
object's administrative and operational value are inherited
from the BGP groups attribute value.
type=bgp.PeerInheritanceMask default=unspecified |
| inheritanceMaskLong |
Serves same purpose as ParamsInheritanceMask but this should be used in cases where the
bit mask of the property is longer than java.lang.Long. Uses bitmask to accommodate
longer values
type=bgp.ParamsInheritanceMaskLong default=unspecified |
| interfaceName |
type=string default= Displayed(tab/group)=Interface Name (/Local Address) |
| ipv4AddPathLimit |
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=IPv4 Add-Path Limit (Behavior/Add-Path) |
| ipv6AddPathLimit |
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=IPv6 Add-Path Limit (Behavior/Add-Path) |
| isMultiPathEligible |
Specifies whether this group neighbor is multi-path eligible.
type=generic.TruthValue default=false Displayed(tab/group)=MultiPath Eligible (/MultiPath) |
| keepAlive |
Set the value of the BGP Keep-alive timer. A keep-alive message
is sent every time this timer expires. A value of 0 means the timer is off.
type=int default=30 minimum=0 maximum=21845 units=seconds Displayed(tab/group)=Keep-Alive (Behavior) |
| keyChainName |
Meaningful only when a key chain is configured on the node.
type=Pointer default= Displayed(tab/group)=BGP Peer Keychain (/KeyChain) |
| l2vpnCiscoInterop |
Specifies whether BGP will provide translation between non-compliant NLRI formats of Cisco.
BGP Peer sessions must be manually configured towards the non-compliant Cisco PEs. When set to
'true', Cisco non-compliant NLRI format will be used; one byte length field instead of two bytes
for BGP NLRI. When set to 'false', Cisco non-compliant NLRI format will not be used or supported.
type=generic.TruthValue default=false Displayed(tab/group)=L2-VPN Cisco Interop Enabled (Behavior) |
| labelIpv4AddPathLimit |
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=Label IPv4 Add-Path Limit (Behavior/Add-Path) |
| labelIpv6AddPathLimit |
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=Label IPv6 Add-Path Limit (Behavior/Add-Path) |
| labelPreference |
The value of this attribute specifies the route
preference for label-IPv4 and label-IPv6 routes learned via the peer.
type=int default=170 minimum=1 maximum=255 Displayed(tab/group)=Label Preference (Behavior) |
| llgrAdvertiseRoute |
The value of llgrAdvertiseRoute decides whether to
withdraw the route towards eBGP peers that did not advertise the LLGR
capability and readvertise to all other peers with the addition of the
LLGR_STALE community.
type=generic.TruthValue default=false Displayed(tab/group)=Advertise Stale Routes (Graceful Restart/Long-lived Graceful Restart) |
| llgrAdvertiseRouteToPeers |
The value of llgrAdvertiseRouteToPeers decides whether to
advertise the route to all peers with the addition of the LLGR_STALE
community.
This can be configured only when llgrAdvertiseRoute is
configured on the system.
type=generic.TruthValue default=false Displayed(tab/group)=Advertise without No Export (Graceful Restart/Long-lived Graceful Restart) |
| llgrAdvertiseStaleTime |
The value of llgrAdvertiseStaleTime specifies the time value
until when a route can be used after the session with the peer is
disconnected
type=long default=86400 minimum=0 maximum=16777215 units=seconds Displayed(tab/group)=Stale Routes Time (Graceful Restart/Long-lived Graceful Restart) |
| llgrForwardingBits |
The value of llgrForwardingBits specifies the behaviour of
the F bit for each AFI/SAFI.
type=bgp.LLGRForwardingBits default=none Displayed(tab/group)=Forwarding Bits (Graceful Restart/Long-lived Graceful Restart) |
| llgrHelperRestartTimeOverride |
The value of llgrHelperRestartTimeOverride specifies the restart time
for the BGP session when it is in helper mode.
type=long default=4096 minimum=0 maximum=4096 units=seconds Displayed(tab/group)=Restart Time Override (Graceful Restart/Long-lived Graceful Restart) |
| llgrHelperStaleTimeOverride |
The value of llgrHelperStaleTimeOverride specifies the stale time
for the BGP session when it is in helper mode.
type=long default=16777216 minimum=0 maximum=16777216 units=seconds Displayed(tab/group)=Stale Routes Time Override (Graceful Restart/Long-lived Graceful Restart) |
| localAS |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Local AS (AS Properties/Local AS) |
| localASNoPrependGlobalAS |
type=generic.TruthValue default=false Displayed(tab/group)=No Prepend Global AS (AS Properties/Local AS) |
| localASPrivate |
If true, specifies that the local autonomous system number is
hidden in paths learned from peering.
type=generic.TruthValue default=false Displayed(tab/group)=Private (AS Properties/Local AS) |
| localAddress |
The local IP address the peer-group or Peer is to use
as advertisement source address.
If set to 0.0.0.0, then use a (non-0.0.0.0) Peer Group
Local Address, or a (non-0.0.0.0) global Local Address,
If both are zero then find the local address by querying
the closest interface to the peer address from the
routing table.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Local Address (/Local Address) |
| localAddressType |
type=rtr.InetAddressType default=ipv4 |
| localPreference |
Set the default value for the Local Preference attribute.
This value is used if the BGP route arrives from a BGP peer
without the Local Pref attribute set. It is overridden by
any value set via a route policy.
type=long default=100 minimum=0 maximum=4294967295 Displayed(tab/group)=Local Preference (Behavior) |
| lockOlcState |
This is used to lock the OLC State while in OLC Maintenance State only.
type=boolean default=false Displayed(tab/group)=Lock OLC State (/OLC) |
| longLivedGracefulRestart |
The value of longLivedGracefulRestart specifies whether or not long lived
graceful restart capabilities are enabled on this instance of BGP.
When the value is set to 'false' long lived graceful restart is
disabled and any previous configuration of other long lived graceful
restart parameters is removed.
type=generic.TruthValue default=false Displayed(tab/group)=Long-lived Graceful Restart (Graceful Restart/Long-lived Graceful Restart) |
| loopDetect |
Determines how the peer session should deal with loop
detection in the AS Path.
type=int default=ignore Displayed(tab/group)=Loop Detect (Behavior) enums= 1: drop 2: ignore 3: off 4: discardRoute |
| loopDetectThreshold |
The value of loopDetectThreshold specifies the occurence of
the global ASN when exceeded triggers the loop-detect behavior.
type=long default=0 minimum=0 maximum=15 Displayed(tab/group)=Loop Detect Threshold (Behavior) |
| mVpnIpv4AddPathLimit |
type=int default=0 minimum=0 maximum=16 Displayed(tab/group)=MVPN IPv4 Add-Path Limit (Behavior/Add-Path) |
| mVpnIpv6AddPathLimit |
type=int default=0 minimum=0 maximum=16 Displayed(tab/group)=MVPN IPv6 Add-Path Limit (Behavior/Add-Path) |
| medSource |
type=int default=none Displayed(tab/group)=MED Source (/MED) enums= 1: igpCost - IGP Cost 2: metricVal - Metric Value 3: none - None |
| medValue |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=MED Value (/MED) |
| mhEbgpResolveLabeledRoutes |
The value of mhEbgpResolveLabeledRoutes specifies whether
multi-hop eBGP learned labeled IP routes to be resolved by IP routes
if no LDP or RSVP-TE LSPs are available
DEPRECATED: 15.0 R1 - No longer supported by NE instead use nextHopResolutionAllowStatic under bgp.site type=generic.TruthValue default=false Displayed(tab/group)=MH EBGP Resolve Labeled Routes (Behavior) |
| minASOrigination |
Determines the minimal interval (in seconds) at which a given path attribute can be advertised to a peer.
type=int default=15 minimum=2 maximum=255 units=seconds Displayed(tab/group)=Min AS Origination (AS Properties) |
| minHoldTime |
Specifies the minimum hold time that should be strictly enforced on HoldTime
type=int default=0 minimum=0 maximum=65535 units=seconds Displayed(tab/group)=Minimum Hold Time (Behavior/Hold Time) |
| minRouteAdvertisement |
type=int default=30 minimum=1 maximum=255 Displayed(tab/group)=Min Route Advertisement (Behavior) |
| minTTLValue |
type=long default=0 minimum=0 maximum=255 Displayed(tab/group)=Minimum TTL Value (Behavior) |
| multiHop |
For peers, tBgpInstanceMultihop configures the TTL used in IP packet header for BGP advertisements.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Multi Hop (Behavior) |
| multicastVpnIpv4AddPathLimit |
type=int default=0 minimum=0 maximum=16 Displayed(tab/group)=Multicast VPN IPv4 Add-Path Limit (Behavior/Add-Path) |
| multicastVpnIpv6AddPathLimit |
type=int default=0 minimum=0 maximum=16 Displayed(tab/group)=Multicast VPN IPv6 Add-Path Limit (Behavior/Add-Path) |
| nextHopReachability |
Specifies whether to enable/disable Next Hop Reachability.
type=boolean default=false Displayed(tab/group)=Next Hop Reachability (Behavior/BFD Strict Mode) |
| nextHopSelf |
When set (true), routes advertised to EBGP peers
have NEXTHOP path attribute set to this router's physical interface.
When false, third party routes are advertised.
type=generic.TruthValue default=false Displayed(tab/group)=Next Hop Self (Behavior) |
| nextHopUnchangedFamily |
When value is set to 'labelIpv4',the
next-hop attribute of an ebgp peer in this peer group remains
unchanged.
type=bgp.NextHopUnChgFamilyMask default=unused Displayed(tab/group)=Next Hop Unchanged (Behavior) |
| olcState |
Object Life Cycle can be set using generic.GenericObject.updateUserObjectLifecycleStates().
type=generic.OLCStates access=read-only default=inService Displayed(tab/group)=Current OLC State (/OLC) |
| operTcpMss |
Specifies the TCP maximum segment size(MSS).
type=int access=read-only Displayed(tab/group)=Operational TCP-MSS (Behavior) |
| originValidation |
The value of this property specifies the address family for which every inbound IPv4 and/or IPv6 route from
the peer is marked with either valid, not-found or invalid origin validation states.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Origin Validation (Behavior) |
| orrLocation |
Specifies the identifier of a location configured under optimal-route-reflection.
The location is used to calculate the next-hop cost in the TE-DB and selects
the best path to advertise to the client of this route-reflector.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Optimal Route-Reflection Location |
| overrideAS |
Specifies whether AS override is enabled on this BGP peer.
AS override on a BGP session monitors outbound routes towards the peer and removes any route
with the peer's ASN in the AS_PATH, replacing it with the advertising router's local ASN or
confederation ID.
type=generic.TruthValue default=false Displayed(tab/group)=AS Override (AS Properties) |
| paramsExtInheritanceHigh |
The value of this specifies the upper 32 bits of inheritance object.
The object specifies if the peer entry in this row, should inherit the operational value of an object,
or use the administratively set value.
This object is a bit-mask, with the following positions:
When the bit for an object is set to one, then the object's administrative and operational value are whatever
the DEFVAL or most recently SET value is.
When the bit for an object is set to zero, then the object's administrative and operational value are inherited from the
corresponding object in PeerGroup, or from the corresponding object in BGP Site.
By default all of these attributes should be inherited from the PeerGroup.
type=long default=0 minimum=0 maximum=4294967295 |
| paramsExtInheritanceLow |
The value of this specifies the lower 32 bits of the inheritance object.
The object specifies if the peer entry in this row, should inherit the operational value of an object,
or use the administratively set value.
When the bit for an object is set to one, then the object's administrative and operational value are whatever
the DEFVAL or most recently SET value is.
When the bit for an object is set to zero, then the object's administrative and operational value are inherited from the
corresponding object in PeerGroup, or from the corresponding object in BGP Site.
By default all of these attributes should be inherited from the bgp PeerGroup.
type=long default=unspecified minimum=0 maximum=4294967295 bits= 0x1: unspecifiedBit0 0x2: unspecifiedBit1 0x4: disableLargeComms 0x8: ebgpLinkBandwidthAccept 0x10: ebgpLinkBandwidthSend 0x20: ebgpLinkBandwidthAggregatePaths 0x100: eBgpPeerNgPreference 0x200: iBgpPeerNgPreference 0x400: eBgpPeerNgLabelPreference 0x800: iBgpPeerNgLabelPreference 0x40: loopDetectThreshold 0x4000: isMultiPathEligible 0x1000: eBgpRejectPolicyImport 0x2000: eBgpRejectPolicyExport 0x3000: eBgpRejectPolicyImportExport 0x10000: bgpPeerNgBlockPrefixSid 0x8000: removePrivateASReplace 0x40000: defaultOriginate 0x80: exportPolicy 0x20000: bgpSelectiveDownload 0x100000: egressPeerEngineering 0x200000: egressPeerEngAdminState 0x4000000: egressPeerEngLabelUnicast 0x80000: tcpMss 0x8000000: evpnLinkBWAddToRcvdBgp 0x800000: segmentRoutingSRv6 0x1000000: routeAdvertise 0x2000000: dropRoutes 0x10000000: advertise 0x20000000: nextHopReachability |
| paramsInheritanceMask |
type=long default=unspecified bits= 0x2: fastExtFailover 0x4: disableComms 0x8: disableExtComms 0x10: defaultOriginate 0x20: advertiseInactiveRts 0x40: minTTLValue 0x80: peerTracking 0x400: authKeyChain 0x800: bfdEnabled 0x4000: advertiseLdpPrefix 0x10000: sendAddPath 0x20000: recvAddPath 0x40000: ipv4AddPathLimit 0x80000: vpnIpv4AddPathLimit 0x100000: ipv6AddPathLimit 0x200000: vpnIpv6AddPathLimit 0x80000000000: labelIpv4AddPathLimit 0x100000000000: labelIpv6AddPathLimit 0x2000000000000: mVpnIpv4AddPathLimit 0x4000000000000: mVpnIpv6AddPathLimit 0x8000000000000: multicastVpnIpv4AddPathLimit 0x10000000000000: multicastVpnIpv6AddPathLimit 0x400000: flowSpecValidate 0x2000: pathMtuDiscovery 0x800000: updatedErrorHandling 0x1000000: defaultRouteTarget 0x2000000: aigp 0x20000000: localASNoPrependGlobalAS 0x40000000: prefixIdleTimeOut 0x80000000: grRestartNotification 0x8000: faultTolerance 0x100000000: dampPeerOscillations 0x8000000: splitHorizon 0x10000000: removePrivateSkipPeerAs 0x2000000000: nextHopUnchangedFamily 0x4000000000: originValidation 0x40000000000: mhEbgpResolveLabeledRoutes 0x200000000000: labelPreference 0x10000000000: ebgpLinkBandwidth 0x20000000000: defaultRxEvpnEncapType 0x1000000000000: enforceFirstAs 0x1000000000000000: interfaceName 0x8000000000: thirdPartyNextHop 0x800000000000000: longLivedGracefulRestart |
| passive |
when set (true), this router will not attempt to connect to the
peer, but will wait for the peer to connect.
type=generic.TruthValue default=false Displayed(tab/group)=Passive (Behavior) |
| pathMtuDiscovery |
Specifies whether path MTU discovery is enabled for this peer.
type=generic.TruthValue default=false Displayed(tab/group)=Path MTU Discovery Enabled (Behavior) |
| peerAS |
Autonomous System number for the remote peer.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Peer AS (AS Properties) |
| peerAddressComponent |
type=InetAddress access=read-create default=0.0.0.0 Displayed(tab/group)=Peer Address |
| peerAddressZoneIndexPointer |
Meaningful only for ipv6z addresses.
type=string access=read-create default= maximum=252 Mandatory on create Displayed(tab/group)=Zone Index |
| peerClusterIdAddrType |
type=rtr.InetAddressType default=ipv4 |
| peerCreationType |
The value of this property indicates the way in which the peer was created.
If the value is 'static', the peer was created statically.
If the value is 'dynamic', the peer was created when the remote BGP speaker
established a connection.
type=int access=read-only default=1 Displayed(tab/group)=Creation Type enums= 1: static - Static 2: dynamic - Dynamic |
| peerType |
type=int default=none Displayed(tab/group)=Peer Type (Behavior) enums= 1: none - None 2: internal - Internal 3: external - External |
| preference |
type=long default=170 minimum=1 maximum=255 Displayed(tab/group)=Preference (Behavior) |
| prefixIdleTimeOut |
specifies the idle time in minutes that the BGP peering remains disabled before attempting to automatically re-establish the connection with this BGP peer after the tBgpPeerNgMaxPrefix limit is reached.
DEPRECATED: 13.0R1 for nodes that support bgp.PrefixLimit class type=long default=0 minimum=0 maximum=4294967295 units=minutes Displayed(tab/group)=Idle Timeout (Behavior/Prefix Limit) |
| prefixLimit |
Configures the maximum number of routes that can
be learned from this peer. zero means 'no limit'.
If the number of routes exceeds 90% of this limit,
then the tBgpMaxPrefix90 notification is sent.
If the number of routes exceeds this limit, then
BGP peering will be dropped. Also, the tBgpMaxPrefix100
notification will be sent.
DEPRECATED: 13.0R1 for nodes that support bgp.PrefixLimit class type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Prefix Limit (Behavior/Prefix Limit) |
| prefixLogOnly |
specifies whether BGP peering will be disabled when tBgpPeerGroupMaxPrefix is exceeded.
When the value is set to 'true', BGP peering will be enabled. When the value is set to 'false',
BGP peering will be disabled
DEPRECATED: 13.0R1 for nodes that support bgp.PrefixLimit class type=generic.TruthValue default=false Displayed(tab/group)=Log Only (Behavior/Prefix Limit) |
| prefixThreshold |
specifies a percentage of prefixLimit
DEPRECATED: 13.0R1 for nodes that support bgp.PrefixLimit class type=int default=90 minimum=1 maximum=100 Displayed(tab/group)=Threshold (Behavior/Prefix Limit) |
| receivedTcpMss |
Specifies the value of the TCP MSS option
received from the remote peer.
type=int access=read-only Displayed(tab/group)=Received TCP-MSS (Behavior) |
| recvAddPath |
type=bgp.BGPAddPathMask default=none Displayed(tab/group)=Add-Path Receive (Behavior/Add-Path) |
| remoteFamily |
type=bgp.IpFamilyMask access=read-only default=unspecified Displayed(tab/group)=Remote Family (VPN/VPN) |
| removePrivateAS |
Determines if private AS numbers should be stripped from
the AS Path before advertising them to BGP peers.
type=generic.TruthValue default=false Displayed(tab/group)=Remove Private AS (AS Properties/Remove Private AS) |
| removePrivateASLmtd |
specifies whether BGP will remove the private AS numbers for this peer.
When the value is true, BGP will remove private AS numbers from the AS Path for this peer
type=generic.TruthValue default=false Displayed(tab/group)=Limited (AS Properties/Remove Private AS) |
| removePrivateASReplace |
Specifies whether BGP will replace private AS numbers for this peer.
type=generic.TruthValue default=false Displayed(tab/group)=Replace (AS Properties/Remove Private AS) |
| removePrivateSkipPeerAs |
specifies whether BGP will remove the private AS skip peers for this peer.
When the value is true, BGP will remove private AS skip peers from the AS Path for this peer.
type=generic.TruthValue default=false Displayed(tab/group)=Skip Peer AS (AS Properties/Remove Private AS) |
| routeAdvertise |
Specifies whether segment routing V6 capabilities for route advertisement
are enabled on this peer of BGP group
type=boolean default=false Displayed(tab/group)=Enable Route Advertise (Segment Routing V6) |
| segmentRoutingV6 |
Specifies whether segment routing V6 capabilities are enabled on this Peer of BGP group
type=boolean default=false Displayed(tab/group)=Enable Segment Routing V6 (Segment Routing V6) |
| sendAddPath |
type=generic.TruthValue default=false Displayed(tab/group)=Enable Add-Path (Behavior/Add-Path) |
| sendExportPolicy |
specifies the send default export policy.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Export Policy (Behavior/Default Originate) |
| sendOrf |
Specifies Add/Remove members to the send Outbound route filtering list
type=generic.TruthValue default=false Displayed(tab/group)=Send ORF (ORF Extended Community) |
| splitHorizon |
When applied to a specific peer, prevent routes from being reflected back to a peer that sends the best route.
type=generic.TruthValue default=false Displayed(tab/group)=Split Horizon (Behavior) |
| staleRoutesTime |
type=long default=360 minimum=1 maximum=3600 units=seconds Displayed(tab/group)=Stale Routes Time (Graceful Restart) |
| tcpMss |
Specifies the TCP maximum segment size(MSS). When the value of TCP maximum segment size is set to 0,
the command removes the static value and allows the TCP MSS value to be calculated
based on the IP MTU value.
type=long default=0 minimum=0 maximum=9746 Displayed(tab/group)=TCP-MSS (Behavior) |
| templateVersionPointer |
Pointer to the template if this object was created from a template.
type=Pointer default= Displayed(tab/group)=Associated Template (Template/Associated Template) |
| thirdPartyNextHop |
The value of thirdPartyNextHop specifies whether there is any
third party next-hop processing done towards single-hop EBGP peers in
this instance.
When the value is false, NEXT_HOP will always carry the IP address of the
interface used to establish the TCP connection to the peer.
type=generic.TruthValue default=false Displayed(tab/group)=Third Party NextHop (Behavior) |
| updatedErrorHandling |
DEPRECATED: 11.0 - Not implemented on node type=generic.TruthValue default=false Displayed(tab/group)=Enable Updated Error Handling (Behavior) |
| useSvcRoutes |
Specifies whether to use Service Routers for this Peer.
type=generic.TruthValue default=false Displayed(tab/group)=Use Service Routes (VPN/VPN) |
| vpnApplyExport |
type=generic.TruthValue default=false Displayed(tab/group)=Apply Export Route Policies (VPN/VPN) |
| vpnApplyImport |
type=generic.TruthValue default=false Displayed(tab/group)=Apply Import Route Policies (VPN/VPN) |
| vpnIpv4AddPathLimit |
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=VPN IPv4 Add-Path Limit (Behavior/Add-Path) |
| vpnIpv6AddPathLimit |
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=VPN IPv6 Add-Path Limit (Behavior/Add-Path) |
| vpnLocalCapabilities |
The value of tBgpPeerVpnLocalCaps indicates the capabilities supported on the local end of the BGP Peer.
type=bgp.VpnCapability access=read-only default=unspecified Displayed(tab/group)=Local Capabilities (VPN/VPN) |
| vpnRemoteCapabilities |
The value of tBgpPeerVpnLocalCaps indicates the capabilities
supported on the remote end of the BGP Peer.
type=bgp.VpnCapability access=read-only default=unspecified Displayed(tab/group)=Remote Capabilities (VPN/VPN) |
| vrfName |
The name of the VPRN site when BGP is used in a PE-CE connection.
This is used for Multi Vendor purposes
type=string default= minimum=0 maximum=252 |
| Properties inherited from rtr.Peer |
|---|
| description, groupName, peerAddress, peerAddressType, routingInstance, routingInstanceName, serviceId, serviceType, siteId, siteName, subscriberId |
| Properties inherited from netw.Connection |
|---|
| administrativeState, application, connectionId, operationalState |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
filter
: FilterHolder -
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
infoList
: List (generic.CommonManagedEntityInformation) - | Methods inherited from rtr.Peer |
|---|
| remove, shutDown, turnUp |