| 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 |
type=boolean default=false Displayed(tab/group)=Advertise (Behavior/BFD Strict Mode) |
| advertiseExternal |
Specifies the address families which are enabled on this router instance
to advertise the best external route to the destination even when
its best overall route is an internal route.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Address Family (VPN/Advertise External) |
| 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 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) |
| allowLocFallback |
Decides what the system should do when the BGP next-hop is not reachable in the TE-DB for the
configured ORR location, tBgpInstanceORRLocation. 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 |
| allowUnresolvedLeaking |
The value specifies whether or not a VPRN can import a route.
type=boolean default=false Displayed(tab/group)=Allow Unresolved Leaking (Next-Hop Resolution) |
| attributeSetRemove |
Controls reception of ATTR_SET in routes received from VPRN BGP peers (PE-CE sessions).
When it is set to 'true', it instructs BGP to remove ATTR_SET in
received BGP routes from PE-CE peers at a stage before the ATTR_SET
could even be used for BGP best path selection. The removal is done
irrespective of whether the PE-CE routes are re-exported as VPN-IP
routes with new ATTR_SET attributes added.
When it is set to 'false', it instructs BGP to leave ATTR_SET in
received BGP routes from PE-CE peers. The ATTR_SET is ignored and not
used in BGP best path selection. The ATTR_SET is copied into VPN-IP
routes accepted by the VRF-export policy and advertised to base
router VPN-IP peers unless it is replaced by a new ATTR_SET as a
result of vRtrBgpIpVpnAttrSetExport is true.
type=boolean default=false Displayed(tab/group)=Remove (/Attribute Set) |
| autonomousSystemNumber |
type=long access=read-only default=0 Displayed(tab/group)=AS Number (AS Properties) |
| backupPath |
Specifies the address families for which the computation and use of a backup path is enabled
on this router instance.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Backup Path (/Backup Path) |
| bfdEnabled |
specifies whether Bi-directional Forwarding Detection is enabled on this
BGP site . When the value is 'true', this BGP 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.Convergence-Set |
type=Children-Set |
| bgp.LabelRouteTunnel-Set |
type=Children-Set |
| bgp.Md5Key-Set |
type=Children-Set |
| bgp.MultiPath-Set |
type=Children-Set |
| bgp.OptimalRouteReflection-Set |
type=Children-Set |
| bgp.PeerGroup-Set |
type=Children-Set |
| bgp.RibManagementIpv4LeakImportPolicy-Set |
type=Children-Set |
| bgp.RibManagementIpv6LeakImportPolicy-Set |
type=Children-Set |
| bgp.RibManagementLabelIpv4LeakImportPolicy-Set |
type=Children-Set |
| bgp.RibManagementLabelIpv6LeakImportPolicy-Set |
type=Children-Set |
| bgp.RouteTableImport-Set |
type=Children-Set |
| bgp.RouteTargetEntry-Set |
type=Children-Set |
| bgp.SRv6AddressFamily-Set |
type=Children-Set |
| bgp.SendOrfRouteTargetEntry-Set |
type=Children-Set |
| bgp.ShortcutTunnel-Set |
type=Children-Set |
| bgp.SiteExportPolicy-Set |
type=Children-Set |
| bgp.SiteImportPolicy-Set |
type=Children-Set |
| bgp.SiteLongLivedGracefulRestart-Set |
type=Children-Set |
| bgpId |
bgpId property specifies the bgp router-id which takes any valid ipv4 host address(default value as 0.0.0.0).
From 16.0.R4 onwards, the rules related to bgp router-id is relaxed (RFC 6286) and should allow any value
from 0.0.0.1 to 255.255.255.255
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Router ID |
| bgpIdAddrType |
type=rtr.InetAddressType default=ipv4 |
| bgpInstanceSplitHorizon |
The value of bgpPGSplitHorizon specifies whether or not the
peers under this instance 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 instance 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) |
| bgpSiteClusterIdAddrType |
type=rtr.InetAddressType default=ipv4 |
| bgpTransportTunnel |
Specify whether VPNs can exchange routes across autonomous system boundaries.
- LDP allows LDP based LSPs to be used as transport from the ASBR to local PE routers
- RSVP-TE allows RSVP-TE based LSPs to be used as transport from the ASBR to local PE routers
- MPLS allows both LDP and RSVP-TE to be used to resolve the BGP next-hop for VPRN routes
in an associated VPRN instance.
This has been replaced by LabelRouteTunnel class from 13.0 R1
DEPRECATED: 13.0.R1 type=bgp.BgpTransportTunnel default=ldp Displayed(tab/group)=Transport Tunnel (Behavior) |
| bgpTunnelPreference |
Determines the preference of the route installed in RTM.
type=int default=12 minimum=1 maximum=255 Displayed(tab/group)=Tunnel Preference (Behavior) |
| blockPrefixSid |
It enables or disables sending of the prefix SID attribute.
type=boolean default=false Displayed(tab/group)=Block Prefix SID (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) |
| chassisType |
The Network Element Chassis Type.
type=equipment.ShelfType default=unknownShelf |
| clusterId |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Cluster ID |
| compMEDStrict |
Specifies whether to compare Multi-Exit Discriminator (MED) path attribute between routes
learned from the same or different neighboring autonomous system (neighbor-AS) in the
route selection process based on the value specified by medCompare
type=generic.TruthValue default=false Displayed(tab/group)=Strict (/Best Path Selection) |
| compareOriginValidationState |
The value specifies whether the origin validation state is used in the BGP decision process.
type=generic.TruthValue default=false Displayed(tab/group)=Compare Origin Validation (/Best Path Selection) |
| confederationAS |
type=long access=read-only default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Confederation AS (AS Properties) |
| connectRetryTime |
type=int default=120 minimum=1 maximum=65535 units=seconds Displayed(tab/group)=Connect Retry Time (Behavior) |
| convMinWaitTimeToAdv |
The value of convMinWaitTimeToAdv specifies the timer value
for which no routes are advertised.
type=int default=0 minimum=0 maximum=3600 Displayed(tab/group)=Minimum Wait To Advertise (Behavior/Convergence) |
| customProperties |
This is used for any custom properties for this objects.
type=Map (string to string) |
| dPathLengthIgnore |
Specifies if BGP ignores the D-PATH domain segment length for best path selection.
DEPRECATED: 25.3.R1 - Deprecated in 25.0 under VPRN type=boolean default=false Displayed(tab/group)=D-Path Length Ignore (/Best Path Selection) |
| 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) |
| 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) |
| description |
type=string default= minimum=0 maximum=80 Displayed(tab/group)=Description |
| deterministicMED |
Configurable change to the BGP best path selection algorithm that makes it more deterministic
when some of the paths being compared come from different neighboring autonomous systems and/or
some do not have a MED attribute
type=generic.TruthValue default=false Displayed(tab/group)=Deterministic MED (/Best Path Selection) |
| disable4ByteASN |
type=generic.TruthValue default=false Displayed(tab/group)=Disable 4Byte ASN (AS Properties) |
| 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) |
| disableExplicitNull |
Specifies whether or not advertised label and associated programming rules are enabled on this
instance of BGP.
type=boolean default=false Displayed(tab/group)=Disable Explicit Null (Behavior/Label Allocation - Label IPv6) |
| 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) |
| disableRtmInstall |
Specifies whether to disable the installation of all (labeled and unlabeled)
IPv4 and IPv6 BGP routes into RTM and the FIB on the base router instance.
type=generic.TruthValue default=false Displayed(tab/group)=Disable Route Table Install (Behavior) |
| disallowIGP |
This has been replaced by ShortcutTunnel class from 13.0 R1
DEPRECATED: 13.0.R1 type=generic.TruthValue default=false Displayed(tab/group)=Disallow IGP (/IGP Shortcut) |
| domainId |
Specifies the Domain ID used in D-Path for routes advertisement BGP vprn service.
DEPRECATED: 25.3.R1 - Deprecated in 25.0 type=string default=0:0 Displayed(tab/group)=D-Path Domain ID (Behavior) |
| domainIdHexValue |
Specifies the HEX format of Domain-id in MIB
DEPRECATED: 25.3.R1 - Deprecated in 25.0 type=string access=read-only default=00 00 00 00 00 00 |
| 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) |
| eBgpLabelPreference |
The value of eBgpLabelPreference 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) |
| eBgpPreference |
The value of eBgpPreference 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) |
| 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 |
| egressPeerEngineering |
Specifies whether to enable/disable egress peer engineering.
type=boolean default=false Displayed(tab/group)=Egress Peer Engineering (Behavior/Egress Peer Engineering) |
| eibgpMultipath |
type=int default=disabled Displayed(tab/group)=EIBGP LoadBalance (/EIBGP LoadBalance) enums= 1: enabled - Enabled 2: disabled - Disabled |
| enableBgpMonitoring |
type=boolean Displayed(tab/group)=Enable Monitoring (BMP) |
| enableInterAsVprn |
type=generic.TruthValue default=false Displayed(tab/group)=Enable Inter AS VPRN (Behavior) |
| enableOrf |
specifies Enable/disable outbound route filtering capability for the BGP instance
type=generic.TruthValue default=false |
| enableRRVpnFwding |
Specifies whether a route-reflector will resolve VPN-IPv4 and VPN-IPv6 routes.
type=generic.TruthValue default=false Displayed(tab/group)=Enable Route Reflector VPN Forwarding (Behavior) |
| enableRapidWithdrawal |
Specifies whether the delay (minimum route advertisement) on sending BGP withdrawals has to be disabled.
type=boolean default=false Displayed(tab/group)=Enable Rapid Withdrawal (Behavior) |
| enableRouteTableLabelRoutes |
Specifies whether we can fall back to RTM resolution of the BGP next hop for labeled routes if
the TTM resolution fails.
type=generic.TruthValue default=false Displayed(tab/group)=Resolve Label Routes (Next-Hop Resolution/Labeled Routes) |
| 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) |
| enforceNeighborTrust |
Specifies the address families on which ILM (Incoming Label Map) forwarding behavior is enabled.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Neighbor Trust (Behavior) |
| equalEbgpIbgp |
Specifies address families for which EBGP and IBGP learned paths are considered equal.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=EBGP IBGP Equal (/Best Path Selection) |
| evpnAddPathLimit |
Specifies the maximum number of paths per EVPN prefix that can be advertised to ADD-PATH
peers.
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=EVPN Add-Path Limit (Behavior/Add-Path) |
| 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 instance 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), Fault Tolerance (Behavior/Error Handling) |
| flowSpecValidate |
specifies whether validation of received flow specification routes is enabled on this router.
type=generic.TruthValue default=false Displayed(tab/group)=Validate Destination Prefix (Behavior/Flow Specification) |
| 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=120 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 |
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) |
| iBgpLabelPreference |
The value of iBgpLabelPreference 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) |
| iBgpPreference |
The value of iBgpPreference specifies the route preference for ibgp routes.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Ingress BGP (Behavior/Default Route Preference) |
| ibgpMultipath |
type=generic.TruthValue default=false Displayed(tab/group)=IBGP MultiPath (/MultiPath) |
| ignoreNextHopMetric |
Specifies whether next-hop metric should be ignored when computing best routes to a
destination for the base router BGP instance
type=generic.TruthValue default=false Displayed(tab/group)=Ignore Next Hop Metric (/Best Path Selection) |
| ignoreRouterId |
Specifies whether to ignore the BGP identifier (router-ID) comparison when comparing two paths
learned from different External BGP (EBGP) neighbors as long as both paths are not from a
BGP confederation peer
type=generic.TruthValue default=false Displayed(tab/group)=Ignore Router ID (/Best Path Selection) |
| ignoreRouterIdInternal |
Specifies the address families of the routes from internal BGP peers for which router-ID is
ignored, during comparison of paths learnt from them.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Ignore Router ID Internal (/Best Path Selection) |
| igpShortcut |
This has been replaced by ShortcutTunnel class from 13.0 R1
DEPRECATED: 13.0.R1 type=bgp.IgpShortcut default=unused Displayed(tab/group)=IGP Shortcut (/IGP Shortcut) |
| importSegmentRoutingPolicy |
The value of importSegmentRoutingPolicy enables or disables import of sr-policy for use
in resolving next-hop.
type=generic.TruthValue default=false Displayed(tab/group)=Import Segment Routing Policy (Behavior) |
| 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) |
| 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) |
| labelIPv6ExplicitNull |
Specifies whether the route can resolve the next-hop, and that route itself is resolved by a
non-BGP route in RTM or a tunnel in TTM
type=generic.TruthValue default=false Displayed(tab/group)=Label IPv6 Explicit Null (Next-Hop Resolution/Labeled Routes/Use BGP Routes) |
| 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) |
| legacyMode |
type=generic.TruthValue default=false Displayed(tab/group)=Legacy Mode (Behavior/Error Handling) |
| linkStateExpEnable |
This decides whether to export the TED database into BGP. If the value is set to 'true', then the BGP instance will allow export
of TED NLRI updates. If the value is set to 'false', then the BGP instance will not export the TED NLRI updates.
type=boolean default=false Displayed(tab/group)=Link State Export Enable (Behavior) |
| linkStateImpEnable |
This decides whether to receive TED NLRI updates. It is only applicable to Virtual Service Router (VSR) running in Network Service Provider (NSP).
If the value is set to 'true', then the BGP instance will import the TED NLRI updates. If the value is set to 'false', then the BGP instance will not import the TED NLRI updates.
type=boolean default=false Displayed(tab/group)=Link State Import Enable (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) |
| 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) |
| medCompare |
type=int default=off Displayed(tab/group)=MED Compare (/Best Path Selection) enums= 1: off 2: zero 3: infinity 4: on |
| 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) |
| 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) |
| mpBgpKeep |
The value of tBgpInstanceMpBgpKeep specifies whether to maintain descriptive
information for all Multiprotocol BGP (MP-BGP) routes on this BGP router instance
regardless of the existing VPRN route policies currently configured.
type=boolean default=false Displayed(tab/group)=Keep MP-BGP Routes |
| multiHop |
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Multi Hop (Behavior) |
| multiPath |
Specifies if BGP multipath is enabled or disabled for this instance. A value of '1' would disable BGP multipath.
Any other value would specify the number of hops for BGP Multipath.
type=int default=1 minimum=1 maximum=16 Displayed(tab/group)=MultiPath (/MultiPath) |
| multiPathEBgp |
Specifies the maximum number of paths that can be installed into RTM when the best path is EBGP and the EIBGP option is not present.
A value of '0' would disable EBGP multipath. Any other value would specify the number of hops for EBGP Multipath.
type=int default=0 minimum=0 maximum=16 Displayed(tab/group)=EBGP (/MultiPath) |
| multiPathIBgp |
Specifies the maximum number of paths that can be installed into RTM when the best path is IBGP and the EIBGP option is not present.
A value of '0' would disable IBGP multipath. Any other value would specify the number of hops for IBGP Multipath.
type=int default=0 minimum=0 maximum=16 Displayed(tab/group)=IBGP (/MultiPath) |
| multiPathRestrict |
Specifies the AS PATH criteria for the BGP multipaths.
type=bgp.MultipathRestrictStatus default=1 Displayed(tab/group)=Restrict (/MultiPath) |
| 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) |
| mvpnVrfImportSubTypeNew |
Specifies whether or not the MPVN VRF route import extended community is assigned the new IANA
extended type code value of 0x010b or the old extended community type code value of 0x010a.
When enabled, the type/subtype in advertised routes is encoded as 0x010b, otherwise the type
is encoded as 0x010a for backwards compatibility.
type=boolean default=false Displayed(tab/group)=IANA MVPN VRF Import Subtype (Behavior) |
| networkPrefixList |
List of network prefixes used by some Multi-Vendor nodes.
type=List (string) |
| nextHopReachability |
type=boolean default=false Displayed(tab/group)=Next Hop Reachability (Behavior/BFD Strict Mode) |
| nextHopResolutionAllowStatic |
Specifies whether we can consider using regular static-route for resolving routes for families
VPN-IPv4, VPN-IPv6, Label-IPv4 and Label-IPv6.
type=generic.TruthValue default=false Displayed(tab/group)=Allow Static Routes (Next-Hop Resolution/Labeled Routes) |
| nextHopResolutionPolicy |
The value of nextHopResolutionPolicy specifies the policy to be applied for filtering the routes
to be considered for next-hop resolution process.
type=string default= Displayed(tab/group)=Policy (Next-Hop Resolution) |
| nextHopResolutionPrefTransFrr |
type=boolean default=false Displayed(tab/group)=Prefer Transport Frr (Next-Hop Resolution/Labeled Routes) |
| nextHopResolutionVpnFamilyPolicy |
The value of nextHopResolutionVPNFamilyPolicy specifies the policy to be applied for filtering
the routes to be considered for next-hop resolution process.
type=string default= maximum=64 Displayed(tab/group)=VPN Family Policy (Next-Hop Resolution) |
| nhResUseBgpRoutes |
Specifies whether to use BGP routes to resolve BGP nexthop for IPv4 and IPv6 families
on this router instance.
type=generic.TruthValue default=false Displayed(tab/group)=Use BGP Routes (Next-Hop Resolution) |
| 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) |
| originValidationUnusable |
This specifies whether to use or ignore the routes that have an origin validation state of 'Invalid'.
When the value is set to 'true', the routes that have an origin validation state of 'Invalid' are
considered unusable.When the value is set to 'false', the routes that have an origin validation
state of 'Invalid' are compared to other usable routes for the same prefix.
type=generic.TruthValue default=false Displayed(tab/group)=Origin Invalid Unusable (/Best Path Selection) |
| 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 |
| orrSpfInitWaitTime |
Specifies the initial hold-off time after a period of stability before starting a new Shortest Path First run to
calculate the cost from an optimal-route-reflection location to a BGP next-hop.
type=int default=5 minimum=1 maximum=300 units=seconds Displayed(tab/group)=Initial Wait Time (/Optimal Route Reflection Shortest Path First Timers) |
| orrSpfMaxWaitTime |
Specifies the maximum hold-off time to start a new Shortest Path First run after a spf trigger is detected.
type=int default=60 minimum=1 maximum=600 units=seconds Displayed(tab/group)=Max Wait Time (/Optimal Route Reflection Shortest Path First Timers) |
| orrSpfSecondWaitTime |
Specifies the additional hold-off time before starting a new Shortest Path First run if further spf triggers are received within the initial wait time.
type=int default=15 minimum=1 maximum=300 units=seconds Displayed(tab/group)=Second Wait Time (/Optimal Route Reflection Shortest Path First Timers) |
| overrideTunnelElc |
When the value is set to 'true', the system should assume that all far-ends for BGP tunnels are
entropy-label capable, irrespective of any received capability signaling.
type=boolean default=false Displayed(tab/group)=Override Tunnel Entropy Label Capability (Behavior) |
| pathIgnore |
type=generic.TruthValue default=false Displayed(tab/group)=AS Path Ignore (VPN/AS Path Ignore) |
| pathIgnoreFamily |
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=AS Path Ignore Family (VPN/AS Path Ignore) |
| pathMtuDiscovery |
Specifies the state of Exponential Backoff Retry mechanism."
type=generic.TruthValue default=false Displayed(tab/group)=Path MTU Discovery Enabled (Behavior) |
| peerAS |
This is used for Multi Vendor purposes.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Peer AS (AS Properties) |
| peerTrackingPolicy |
The value of peerTrackingPolicy specifies the policy to be applied for BGP peer tracking on this
router instance.
type=string default= Displayed(tab/group)=Peer Tracking Policy (Behavior) |
| preferAigp |
If preferAigp is enabled the metric of the route installed in RTM is the aigp-metric of the route if no aigp-metric is
available the value of tunnelMetric is used
type=boolean default=false Displayed(tab/group)=Prefer AIGP (/Tunnel Metric) |
| preferMed |
If preferMed is enabled the metric of the route installed in the tunnel-table is the med-metric of the route if no
med-metric is available the value of tunnelMetric is used.
type=boolean default=false Displayed(tab/group)=Prefer MED (/Tunnel Metric) |
| preference |
type=long default=170 minimum=1 maximum=255 Displayed(tab/group)=Preference (Behavior) |
| prefixSidRangeMax |
Specifies the maximum local SID index that can be used.
type=long default=1 minimum=0 maximum=524287 Displayed(tab/group)=Max Index (Segment Routing/Prefix SID) |
| prefixSidStartRange |
Specifies the local label starting offset value.
type=long default=0 minimum=0 maximum=524287 Displayed(tab/group)=Start Label (Segment Routing/Prefix SID) |
| prefixSidType |
Specifies whether local or global operation mode is applicable for SID prefixes.
type=isis.PrefixSIDType default=none Displayed(tab/group)=Type (Segment Routing/Prefix SID) |
| purgeTime |
type=long default=10 minimum=1 maximum=60 units=minutes Displayed(tab/group)=Purge Time (Behavior) |
| rapidUpdate |
Enable/Disable BGP rapid update for specified address-families.
When no address family is specified, this function is disabled.
type=bgp.IpFamilyMask default=unspecified Displayed(tab/group)=Address Family (VPN/Rapid Update) |
| 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.
When the value is true, BGP will remove private AS numbers from the AS Path.
type=generic.TruthValue default=false Displayed(tab/group)=Limited (AS Properties/Remove Private AS) |
| removePrivateASReplace |
Specifies if private AS numbers in the AS Path should be replaced with the configured global
AS before advertising them to BGP peers.
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.
When the value is true, BGP will remove private AS skip peers from the AS Path.
type=generic.TruthValue default=false Displayed(tab/group)=Skip Peer AS (AS Properties/Remove Private AS) |
| segmentRouting |
Specifies whether or not segment routing capabilities are enabled on this instance of BGP. When the value is set to 'false'
segment routing is disabled and any previous configuration of other segment routing parameters is removed.
type=boolean default=false Displayed(tab/group)=Enable Segment Routing (Segment Routing) |
| segmentRoutingAdminState |
Specifies the desired administrative state of Segment Routing for this BGP instance.
type=int default=3 Displayed(tab/group)=Administrative State (Segment Routing) enums= 2: up - Up 3: down - Down |
| segmentRoutingV6 |
Specifies whether or not segment routing V6 capabilities are enabled on this instance of BGP.
When the value is set to 'false' segment routing V6 is disabled and any previous configuration of other segment routing parameters is removed.
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) |
| selectiveIpPrioritization |
It specifies whether to enable/disable prioritization of selective download routes.
type=boolean default=false Displayed(tab/group)=IP Prioritization (Behavior) |
| selectiveLabelIp |
It specifies the behaviour on how to install label IP routes.
type=int default=none Displayed(tab/group)=Selective Label IP (Behavior) enums= 0: none - None 1: noInstall - No Install 2: routeTableInstallOnly - Route Table Install Only |
| sendAddPath |
type=generic.TruthValue default=false Displayed(tab/group)=Enable Add-Path Send (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) |
| srv6SourceAddress |
Specifies the source address.
type=InetAddress Displayed(tab/group)=Source Address (Segment Routing V6) |
| srv6SourceAddressType |
Specifies the type of address stored in property srv6SourceAddress.
type=rtr.InetAddressType default=unknown |
| staleRoutesTime |
type=long default=360 minimum=1 maximum=3600 units=seconds Displayed(tab/group)=Stale Routes Time (Graceful Restart) |
| subconfedVpnForwarding |
Specifies whether a route-reflector will resolve VPN-IPv4 and VPN-IPv6 routes.
type=generic.TruthValue default=false Displayed(tab/group)=Subconfed VPN Forwarding (Behavior) |
| 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) |
| tunnelMetric |
determines the metric of the route installed in RTM
type=long default=1000 minimum=0 maximum=4294967295 Displayed(tab/group)=Tunnel Metric (/Tunnel Metric) |
| useLeakedRoutesStatic |
Specifies whether non-leaked IPv4-unicast or IPv6-unicast route will be resolved by leaked static routes.
When the value is 'true', non-leaked IPv4-unicast or IPv6-unicast route should be resolved by leaked static routes.
When the value is 'false', non-leaked IPv4-unicast or IPv6-unicast route should not be resolved by leaked static routes.
type=boolean default=false Displayed(tab/group)=Use Leaked Static Routes (Next-Hop Resolution/Use Leaked Routes) |
| validateRedirectIp |
Specifies whether validation of flow specification routes received with a
redirect-to-IPv4 extended community is enabled on this router.
type=generic.TruthValue default=false Displayed(tab/group)=Validate Redirect IP (Behavior/Flow Specification) |
| 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 |
| weightedEcmp |
The value of weightedEcmp specifies that if it is enabled, then ECMP is applied
across LSPs to the same BGP next-hop, based on the configured load-balancing-weight of each LSP.
type=generic.TruthValue default=false Displayed(tab/group)=Weighted ECMP (Next-Hop Resolution) |
| Overridden Properties | |
|---|---|
| administrativeState |
default=bgpUp |
| displayedName |
default=BGP |
| Properties inherited from rtr.ProtocolSite |
|---|
| creationOrigin, serviceId, serviceType, subscriberId |
| Properties inherited from rtr.RouterSite |
|---|
| routerId, routerName, routingInstancePointer |
| Properties inherited from netw.NetworkSite |
|---|
| displayedName, siteId, siteName |
| Properties inherited from netw.SubnetworkConnection |
|---|
| domain |
| 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.ProtocolSite |
|---|
| shutDown, turnUp |