| 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 group
supports extended next-hop encoding and resolution.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Advertise IPv6 NextHop Family (Behavior) |
| aggregatorIdZero |
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 group.
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, tBgpPGORRLocation. 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 group . When the value is 'true', this BGP group 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.DynamicPeer-Set |
type=Children-Set |
| bgp.DynamicPeerInterface-Set |
type=Children-Set |
| bgp.GroupExportPolicy-Set |
type=Children-Set |
| bgp.GroupImportPolicy-Set |
type=Children-Set |
| bgp.GroupLongLivedGracefulRestart-Set |
type=Children-Set |
| bgp.Md5Key-Set |
type=Children-Set |
| bgp.Peer-Set |
type=Children-Set |
| bgp.PeerGroupAddPath-Set |
type=Children-Set |
| bgp.PeerGroupSRv6-Set |
type=Children-Set |
| bgp.PeerGroupSendOrfRouteTargetEntry-Set |
type=Children-Set |
| bgp.PrefixLimit-Set |
type=Children-Set |
| bgpPGBlockPrefixSid |
It enables or disables sending of the prefix SID attribute.
type=boolean default=false Displayed(tab/group)=Block Prefix SID (Behavior) |
| bgpPGSplitHorizon |
The value of bgpPGSplitHorizon specifies whether or not the
peers under this group reflect the best route back to the peer
from which the route was received.
When the value of bgpPGSplitHorizon is 'true', the peers under
this group will not reflect best routes to the peers from which
the route was received."
type=generic.TruthValue default=false Displayed(tab/group)=Split Horizon (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 |
| clusterIdAddrType |
type=rtr.InetAddressType default=ipv4 |
| connectRetryTime |
type=int default=120 minimum=1 maximum=65535 units=seconds Displayed(tab/group)=Connect Retry Time (Behavior) |
| 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 |
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 specifies whether to send the default Route Target Constraint (RTC)
route to peers in this BGP peer group.
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 group.
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 |
type=generic.TruthValue default=false Displayed(tab/group)=Disable Large Communities (Behavior) |
| dropRoutes |
Specifies whether to drop routes with srv6 tlvs for this group of BGP
type=boolean default=false Displayed(tab/group)=Enable Drop Routes (Segment Routing V6) |
| dynamicPeer |
type=generic.TruthValue access=read-create default=false Displayed(tab/group)=Dynamic Peer |
| dynamicPeerLimit |
The value of this property specifies the dynamic peer limit for this BGP Peer.
type=int default=0 minimum=0 maximum=8192 Displayed(tab/group)=Dynamic Peer Limit (Behavior) |
| eBgpPGLabelPreference |
The value of eBgpPGLabelPreference 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) |
| eBgpPGPreference |
The value of eBgpPGPreference 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.
The eBgpRejectPolicyImport and eBgpRejectPolicyExport are to be modified together. If one of
them is inherited, the other also gets inherited while if one gets un-inherited the other
also gets un-inherited.
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.
The eBgpRejectPolicyImport and eBgpRejectPolicyExport are to be modified together. If one of
them is inherited, the other also gets inherited while if one gets un-inherited the other
also gets un-inherited.
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 group 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 peer group.
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 group 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 type of AFI/SAFI the Bgp group 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 for this peer group.
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=1 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 group.
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) |
| iBgpPGLabelPreference |
The value of iBgpPGLabelPreference 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) |
| iBgpPGPreference |
The value of iBgpPGPreference 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 |
type=long default=unspecified bits= 0x4: administrativeState 0x10: connectRetryTime 0x20: holdTime 0x40: keepAlive - Keep-Alive 0x80: minASOrigination 0x100: damping 0x400: localAS 0x800: localPreference 0x1000: loopDetect 0x2000: minRouteAdvertisement 0x8000: medSource 0x10000: medValue 0x20000: multiHop 0x100000: aggregatorIdZero 0x1000000: preference 0x2000000: removePrivateAS 0x8000000: importPolicy1 0x10000000: importPolicy2 0x20000000: importPolicy3 0x40000000: importPolicy4 0x80000000: importPolicy5 0x100000000: exportPolicy1 0x200000000: exportPolicy2 0x400000000: exportPolicy3 0x800000000: exportPolicy4 0x1000000000: exportPolicy5 0x2000000000: localASPrivate 0x4000000000: md5Auth 0x8000000000: md5AuthKey 0x10000000000: clusterId 0x20000000000: disableClientReflect 0x40000000000: gracefulRestart 0x80000000000: grRestartTime 0x100000000000: grStaleRoute 0x200000000000: grAdmininstrativeState 0x400000000000: family 0x800000000000: vpnApplyImport 0x1000000000000: vpnApplyExport 0x4000000000000: enableOrf 0x8000000000000: extCommsOrf 0x10000000000000: sendOrf 0x20000000000000: acceptOrf 0x80000000000000: disable4ByteASN 0x100000000000000: holdTimeIsStrict 0x200000000000000: removePrivateASLmtd 0x400000000000000: pathMtuDiscovery |
| 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 is multi-path eligible.
type=generic.TruthValue default=false Displayed(tab/group)=MultiPath Eligible (/MultiPath) |
| keepAlive |
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) |
| 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 |
type=generic.TruthValue default=false Displayed(tab/group)=Private (AS Properties/Local AS) |
| localAddress |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=IP Address (/Local Address) |
| localAddressType |
type=rtr.InetAddressType default=ipv4 |
| localPreference |
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 |
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 |
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 |
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 |
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) |
| 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 if the service provider BGP
will override the customer AS number in the AS PATH with its own AS number.
type=generic.TruthValue default=false Displayed(tab/group)=AS Override (AS Properties) |
| paramsExtInheritanceHigh |
The value of paramsExtInheritanceHigh 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 tBgpInstanceTable.
By default all of these attributes should be inherited from the
tBgpInstanceTable.
type=long default=0 minimum=0 maximum=4294967295 |
| paramsExtInheritanceLow |
The value of paramsExtInheritanceLow 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 tBgpInstanceTable.
By default all of these attributes should be inherited from the
tBgpInstanceTable.
type=long default=0 minimum=0 maximum=4294967295 bits= 0x4: ebgpLinkBandwidthAccept 0x8: ebgpLinkBandwidthSend 0x10: ebgpLinkBandwidthAggregatePaths 0x80: eBgpPGPreference 0x100: iBgpPGPreference 0x200: eBgpPGLabelPreference 0x400: iBgpPGLabelPreference 0x20: loopDetectThreshold 0x800: eBgpRejectPolicyImport 0x1000: eBgpRejectPolicyExport 0x1800: eBgpRejectPolicyImportExport 0x2000: eBgpMultiPathEligible 0x8000: bgpPGBlockPrefixSid 0x4000: removePrivateASReplace 0x10000: defaultOriginate 0x40: exportPolicy 0x40000: selectiveDownload 0x80000: egressPeerEngineering 0x100000: egressPeerEngAdminState 0x20000: tcpMss 0x8000000: advertise 0x10000000: nextHopReachability |
| paramsInheritanceMask |
type=long default=unspecified bits= 0x2: fastExtFailover 0x4: disableComms 0x8: disableExtComms 0x10: defaultOriginate 0x20: advertiseInactiveRts 0x400: peerTracking 0x800: authKeyChain 0x1000: bfdEnabled 0x2000: sendAddPath 0x4000: recvAddPath 0x8000: ipv4AddPathLimit 0x10000: vpnIpv4AddPathLimit 0x20000: ipv6AddPathLimit 0x40000: vpnIpv6AddPathLimit 0x20000000000: labelIpv4AddPathLimit 0x40000000000: labelIpv6AddPathLimit 0x80000: flowSpecValidate 0x2000000: localASNoPrependGlobalAS 0x8000000: grRestartNotification 0x10000000: faultTolerance 0x20000000: dampPeerOscillations 0x400000000: bgpPGSplitHorizon 0x1000000: removePrivateSkipPeerAs 0x80000000000: labelPreference 0x100000000000: defaultRxEvpnEncapType 0x800000000000: enforceFirstAs 0x1000000000000: mVpnIpv4AddPathLimit 0x2000000000000: mVpnIpv6AddPathLimit 0x4000000000000: multicastVpnIpv4AddPathLimit 0x8000000000000: multicastVpnIpv6AddPathLimit 0x2000000000: thirdPartyNextHop 0x400000000000000: longLivedGracefulRestart 0x4000000000000000: byPassMRAITimer 0x10000000000: evpnAddPathLimit |
| paramsInheritanceMaskLong |
type=bgp.GroupParamsInheritanceMaskLong default=unspecified |
| passive |
type=generic.TruthValue default=false Displayed(tab/group)=Passive (Behavior) |
| pathMtuDiscovery |
Specifies whether path MTU discovery is enabled for this group.
type=generic.TruthValue default=false Displayed(tab/group)=Path MTU Discovery Enabled (Behavior) |
| peerAS |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Peer AS (AS Properties) |
| 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 |
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."
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) |
| recvAddPath |
type=bgp.BGPAddPathMask default=none Displayed(tab/group)=Add-Path Receive (Behavior/Add-Path) |
| removePrivateAS |
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 group.
When the value is true, BGP will remove private AS numbers from the AS Path for this group.
type=generic.TruthValue default=false Displayed(tab/group)=Limited (AS Properties/Remove Private AS) |
| removePrivateASReplace |
Specifies whether or not to replace the private autonomous system number (ASN) in AS-Path, if the
AS-Path contains the ASN of the external BGP (eBGP) neighbor on this
BGP peer group.
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 group.
When the value is true, BGP will remove private AS skip peers from the AS Path for this group.
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 group of BGP
type=boolean default=false Displayed(tab/group)=Enable Route Advertise (Segment Routing V6) |
| segmentRoutingV6 |
Specifies whether segment routing V6 capabilities are enabled on this group of BGP
type=boolean default=false Displayed(tab/group)=Enable Segment Routing V6 (Segment Routing V6) |
| selectiveDownload |
It specifies whether to enable/disable selective download of label-ipv4 routes.
type=boolean default=false Displayed(tab/group)=Selective Download (Behavior) |
| 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) |
| 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 |
Specifies whether updated error handling is enabled for this group.
DEPRECATED: 11.0 - Not implemented on node type=generic.TruthValue default=false Displayed(tab/group)=Enable Updated Error Handling (Behavior) |
| 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) |
| 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 |
| Overridden Properties | |
|---|---|
| administrativeState |
default=bgpUp |
| groupName |
maximum=64 |
| operationalState |
default=bgpUp |
| Properties inherited from rtr.Group |
|---|
| description, domain, groupName, 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.Group |
|---|
| remove, shutDown, turnUp |