ospf
Site

Site contains information describing the configured parameters and cumulative statistics of an OSPF instance.



public class Site

Stats:
ospf.OspfStats ospf.SiteSegmentIdentifierStats ospf.SiteStats

Properties
adjacencySidHold Specifies the adjacency SID hold time in seconds.

type=int
default=15
minimum=0
maximum=300
units=seconds
Displayed(tab/group)=Adjacency SID Hold Time (Segment Routing.General)

advRouterLsaLimit Specifies the maximum number of LSAs we allow to be advertised by one router. If the number of LSAs from one router exceeds this number, further LSAs are ignored and OSPF goes into overload. A value of 0 indicates no limit.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=LSA Limit (Behavior/Link State Advertisements)

advRouterLsaLimitLogOnly Specifies whether OSPF should go into overload when Lsa Limit is reached. A value of false indicates overload should be triggered, true indicates only a trap needs to be sent.

type=generic.TruthValue
default=false
Displayed(tab/group)=Log Only (Behavior/Link State Advertisements)

advRouterLsaLimitTimeout Specifies the maximum timeout in seconds we go into overload when Lsa Limit is reached. A value of 0 indicates indefinite.

type=long
default=0
minimum=0
maximum=1800
units=seconds
Displayed(tab/group)=Timeout (Behavior/Link State Advertisements)

advRouterLsaLimitWarning Specifies the percentage of the Lsa Limit, at which a warning log message and SNMP notification will be sent. This will be a warning and additional routes will be learned up to 100% of Lsa Limit. A value of 0 indicates that this property is disabled and no log message or SNMP notification will be sent.

type=int
default=0
minimum=0
maximum=100
units=%
Displayed(tab/group)=Threshold (Behavior/Link State Advertisements)

advertiseTunnelLink The value of tmnxOspfAdvertiseTunnelLink indicates whether advertisement of LSP shortcuts into IGP has been enabled or disabled for OSPF. When the value of tmnxOspfAdvertiseTunnelLink is set to true LSP shortcut advertisement into IGP is enabled and when tmnxOspfAdvertiseTunnelLink is set to false LSP shortcut advertisement into IGP is disabled.

type=boolean
default=false
Displayed(tab/group)=Advertise Tunnel Links Enabled (Behavior/OSPFv2)

allocateDualSid The value of allocateDualSid specifies whether instantiating and advertising dual adjacency SIDs per interface is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Allocate Dual SID (Segment Routing.General/Adjacency SID)

asScopeLsaChecksumSum

type=long
access=read-only
default=0
Displayed(tab/group)=AS-Scope Checksum Sum (Behavior/Link State Advertisements)

asScopeLsaCount

type=long
access=read-only
default=0
Displayed(tab/group)=AS-Scope Count (Behavior/Link State Advertisements)

averageSpfRunTime

type=int
access=read-only
default=0
minimum=0
maximum=2147483647
units=1/100 s
Displayed(tab/group)=Average Run Time (Dijkstra/Statistics)

backupNodeSID Specifies the value of the label or index to be used for the prefix representing the primary address of the IPv4 network interface of type 'loopback'.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Backup SID Value (Segment Routing.General/Backup SID)

backupNodeSIDType Specifies what type of value is to be used for the prefix representing the primary address of the IPv4 network interface of type 'loopback'.

type=ospf.SIDType
default=none
Displayed(tab/group)=Backup SID Type (Segment Routing.General/Backup SID)

backupNodeSIDipPrefix Specifies the IP Address of the prefix.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Backup SID IP Prefix (Segment Routing.General/Backup SID)

backupNodeSIDipPrefixLength Specifies the number of leading one bits that form the mask to be logical-ANDed with tmnxOspfBackupNodeSidPfx.

type=int
default=32
minimum=0
maximum=32
Displayed(tab/group)=Backup SID IP Prefix Length (Segment Routing.General/Backup SID)

backupNodeSIDipPrefixType Specifies the IP address type of sidMapPrefix

type=rtr.InetAddressType
default=ipv4

bgpLsId The value of the object bgpLsId specifies the BGP-LS identifier that is sent in the BGP-LS NLRI. The BGP-LS identifier is used along with the ASN to correlate the BGP-LS NLRI advertisements of multiple BGP-LS speakers of the same IGP domain. The value of this object is ignored when the object bgpLsIdSet is false.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Value (Behavior/Database Export)

bgpLsIdSet The value of the object bgpLsIdSet specifies whether to use the value of bgpLsId or not. When set to true(1), the value of bgpLsId is used to identify the BGP-LS in the BGP-LS NLRI. When set to false, no BGP-LS identifier is sent in the BGP-LS NLRI.

type=boolean
default=false
Displayed(tab/group)=Bgp-Ls-Identifier (Behavior/Database Export)

bootOverloadAdmininstrativeState

type=int
default=disabled
Displayed(tab/group)=Boot Overload Enabled (Overload)
enums=
    1: disabled - Disabled
    2: enabled - Enabled
    3: enabledWaitForBgp - Enabled, Wait For BGP (not selectable)

bootOverloadInterval

type=int
default=0
minimum=0
maximum=1800
units=seconds
Displayed(tab/group)=Boot Overload Interval (Overload)

classForwarding Specifies whether Class Based Forwarding is enabled or not. If the value is 'true', Class Based Forwarding with ECMP for SR-OSPF over RSVP-TE LSPs as IGP shortcuts is enabled.

type=boolean
default=false
Displayed(tab/group)=Class Forwarding (Segment Routing.General)

customProperties This is used for any custom properties for this objects.

type=Map (string to string)

databaseExport Specifies whether database export has been enabled or disabled for this OSPF instance. When the value of tmnxOspfDatabaseExport is 'enabled', OSPF will redistribute LSDB via segment routing TE-DB into NLRI format.

type=boolean
default=false
Displayed(tab/group)=Database Export (Behavior/Database Export)

databaseExportId unique identifier of the IGP instance in the BGP-LS NLRI. The value of this object is ignored when the object databaseExportIdSet is false.

type=string
default=0
minimum=1
maximum=20
Displayed(tab/group)=Value (Behavior/Database Export)

databaseExportIdSet The value of the object databaseExportIdSet specifies whether to use the values of databaseExportIdLow and databaseExportIdHigh or not. When set to true(1), the values of databaseExportIdLow and databaseExportIdHigh are used to uniquely identify the IGP instance in the BGP-LS NLRI. When set to false, the identifier in the BGP-LS NLRI defaults to the IGP instance number assigned by SROS.

type=boolean
default=false
Displayed(tab/group)=Identifier (Behavior/Database Export)

defaultRouteRedistributeMetric

type=long
default=10
minimum=0
maximum=16777214
Displayed(tab/group)=Route Metric (/OSPF Redistribution)

defaultRouteRedistributeMetricType

type=int
default=type2
Displayed(tab/group)=Route Metric Type (/OSPF Redistribution)
enums=
    1: type1 - Type 1
    2: type2 - Type 2

domainId specifies the domain-id associated with this instance of OSPF on the router. If no value is specified for tmnxOspfAsbrDomainId, it is set to -1

type=int
default=-1
minimum=-1
maximum=31
Displayed(tab/group)=Domain ID (/Autonomous System Border Router)

egressStatsAdjacencySet Specifies whether egress statistic collection on Adjacency sets is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Adjacency Set Egress Statistics (Segment Routing.General/SID Statistics)

egressStatsAdjacencySid Specifies whether egress statistic collection on Adjacency SIDs is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Adjacency SID Egress Statistics (Segment Routing.General/SID Statistics)

egressStatsNodeSid Specifies whether egress statistic collection on Node SIDs is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Node SID Egress Statistics (Segment Routing.General/SID Statistics)

enableLdpSync specifies whether the IGP-LDP synchronization feature is enabled or disabled on all interfaces participating in the OSPF routing protocol

type=boolean
default=true
Displayed(tab/group)=Enable LDP Synchronization (Behavior)

entropyLabel Specifies whether processing of received entropy label capability (ELC) advertisements is enabled or not for this OSPF instance.

type=int
default=1
Displayed(tab/group)=Entropy Label (Segment Routing.General)
enums=
    1: enable - Enable
    2: forceDisable - Force Disable

exitOverflowInterval

type=int
default=0
minimum=0
maximum=2147483647
units=seconds
Displayed(tab/group)=Exit Overflow Interval (Behavior/Overflow Control)

exportLimit The value of tmnxOspfExportLimit specifies the maximum number of routes or prefixes that can be exported into OSPF or OSPF3 from the route table. A value of 0 indicates that the export limit for routes or prefixes has been disabled.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Export Limit (Behavior)

exportLimitLogPercent The value of tmnxOspfExportLimitLogPercent specifies the percentage of the export-limit, at which a warning log message and SNMP notification would be sent. This would only be a warning and additional routes will be learned up to 100% of tmnxOspfExportLimit. A value of 0 indicates that tmnxOspfExportLimitLogPercent is disabled and no log message or SNMP notification would be sent.

type=int
default=0
minimum=0
maximum=100
Displayed(tab/group)=Export Limit Log Percent (Behavior)

exportTunnelTableProtocol Specifies the protocol Segment Routing is stitched to. If the value is none (0), OSPF will not export tunnels from the Tunnel Table Manager (TTM). If the value is ldp (1), OSPF will export LDP tunnels from TTM to the Segment Routing (SR).

type=int
default=0
Displayed(tab/group)=Export Tunnel Table Protocol (Segment Routing.General)
enums=
    0: none - None
    1: ldp - LDP

exportedRoutes The value of tmnxOspfTotalExportedRoutes indicates the total number of routes exported into OSPF from the route table manager when an export policy is configured. Value of tmnxOspfTotalExportedRoutes would be 0 when no export policy is configured.

type=long
access=read-only
Displayed(tab/group)=Total Exported Routes (Behavior)

extendedLsa Specifies whether or not to use extended LSAs for this OSPFv3 instance.

type=ospf.ExtendedLsaType
default=0
Displayed(tab/group)=Extended LSA (Behavior/Link State Advertisements)

externalLsaChecksumSum

type=long
access=read-only
default=0
Displayed(tab/group)=External (LS Type 5) Checksum Sum (Behavior/Link State Advertisements)

externalLsaCount

type=long
access=read-only
default=0
Displayed(tab/group)=External (LS Type 5) Count (Behavior/Link State Advertisements)

externalLsdbLimit

type=int
default=-1
minimum=-1
maximum=2147483647
Displayed(tab/group)=External LSA Limit (Behavior/Overflow Control)

externalPreference

type=int
default=150
minimum=1
maximum=255
Displayed(tab/group)=External (Behavior/Route Preferences)

flexAlgoAdministrativeState Specifies the administrative state of all Flexible Algorithm processing for this OSPF instance.

type=netw.AdministrativeState
default=ospfDown
Displayed(tab/group)=Administrative State (Flexible Algorithms)

flexAlgoAdvertiseAdminGrp Specifies whether Admin Group (AG) TLV, Extended Admin Group (EAG) TLV or both must be advertised. If the value is 'preferAg', an AG tlv will be advertised representing all admin-group affinity bits set in range [0..31]. If an admin-group from the extended range [32..255] is used then a second EAG TLV will be advertised representing all admin-group affinity bits set in range [0..255]. If the value is 'eagOnly', only an EAG TLV will be advertised. If the value is 'agEag', both AG and EAG TLV's will be advertised even if there is no affinity bit set in the extended EAG range.

type=ospf.FlexAlgoAdvertiseAdminGrpType
default=preferAg
Displayed(tab/group)=Advertise Admin Group (Flexible Algorithms)

fullLfaRunCount The value of fullLfaRunCount indicates the total number of times that complete LFA SPF has been run on the router since OSPF was last enabled.

type=long
access=read-only
default=0
Displayed(tab/group)=Number of Full LFA Runs (Dijkstra/Statistics)

fullSpfRunCount

type=long
access=read-only
default=0
Displayed(tab/group)=Number Of Full SPF Runs (Dijkstra/Statistics)

grHelperMode

type=generic.TruthValue
default=false
Displayed(tab/group)=Helper Mode (Graceful Restart)

grStrictLsaChecking It specifies whether or not to perform strict LSA checking during OSPF graceful restart.

type=generic.TruthValue
default=true
Displayed(tab/group)=Strict LSA Checking (Graceful Restart)

gracefulRestart

type=generic.TruthValue
default=false
Displayed(tab/group)=Graceful Restart (Graceful Restart)

ifBaseRefCost

type=long
default=100000000
minimum=1
maximum=100000000
units=Kb/s
Displayed(tab/group)=Interface Base Reference Cost (Behavior/Interface Base Reference Cost)

ifBaseRefCostLong

type=string
default=100000000
minimum=1
maximum=20
units=Kb/s
Displayed(tab/group)=Interface Base Reference Cost (Behavior/Interface Base Reference Cost)

ignoreDNBit Specifies whether to ignore the DN bit for OSPF LSA packets for this instance of OSPF on the router. When ignoreDNBit has a value of 'true' the DN bit for OSPF LSA packets will be ignored. When it has a value of 'false' the DN bit will not be ignored for OSPF LSA packets."

type=boolean
default=false
Displayed(tab/group)=Ignore DN Bit (Behavior)

igpShortcutAdminState Specifies the desired administrative state for IGP shortcuts on this OSPF instance.

type=rtr.IgpShortcutAdminState
default=down
Displayed(tab/group)=Administrative State (IGP Shortcut)

igpShortcutAllowSRoverSRTE Specifies the desired allow SR over SRTE state for IGP shortcuts on this OSPF instance.

type=boolean
default=false
Displayed(tab/group)=Allow SR over SRTE (IGP Shortcut)

incrSpfWait The value of incrSpfWait defines the internal OSPF delay before an incremental SPF calculation is performed.

type=int
default=1000
minimum=0
maximum=1000
units=milliseconds
Displayed(tab/group)=Incremental SPF Wait (Dijkstra/Configuration)

incrementalExternalSpfRunCount

type=long
access=read-only
default=0
Displayed(tab/group)=Incremental External Run Count (Dijkstra/Statistics)

incrementalInternalSpfRunCount

type=long
access=read-only
default=0
Displayed(tab/group)=Incremental Internal Run Count (Dijkstra/Statistics)

ingressStatsAdjacencySet Specifies whether ingress statistic collection on Adjacency sets is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Adjacency Set Ingress Statistics (Segment Routing.General/SID Statistics)

ingressStatsAdjacencySid Specifies whether ingress statistic collection on Adjacency SIDs is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Adjacency SID Ingress Statistics (Segment Routing.General/SID Statistics)

ingressStatsNodeSid Specifies whether ingress statistic collection on Node SIDs is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Node SID Ingress Statistics (Segment Routing.General/SID Statistics)

instanceIndex Identifies a specific instance of a version of the OSPF protocol running in the router instance specified by the routerId.

type=long
default=0
minimum=0
maximum=95
Displayed(tab/group)=Instance ID (/OSPF Instance)

internalPreference

type=int
default=10
minimum=1
maximum=255
Displayed(tab/group)=Internal (Behavior/Route Preferences)

isAreaBorderRouter

type=boolean
access=read-only
default=false
Displayed(tab/group)=Area Border Router (/Type)

isAutonomousSystemBorderRouter

type=boolean
default=false
Displayed(tab/group)=Autonomous System Border Router (/Type)

isBackBoneRouter

type=boolean
access=read-only
default=false
Displayed(tab/group)=Backbone Router (/Type)

isInOverflowState

type=boolean
access=read-only
default=false
Displayed(tab/group)=LSDB Overflow State (Behavior/Overflow Control)

isRFC1583Compatible

type=boolean
default=true
Displayed(tab/group)=RFC1583 Compatible (Behavior/OSPFv2)

lastEnabledTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Time Enabled (/State)

lastExternalSpfRunTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Time Ran (Dijkstra/Statistics)

lastFullSpfRunTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Time Full SPF Ran (Dijkstra/Statistics)

lastLfaRunTime The value of lastLfaRunTime indicates the time at which the system last performed a LFA SPF run.

type=Date
access=read-only
Displayed(tab/group)=Last Time Full SPF LFA Ran (Dijkstra/Statistics)

lastOverflowEnteredTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Time Entered (Behavior/Overflow Control)

lastOverflowExitTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Time of Exit (Behavior/Overflow Control)

ldpOverRsvp The value of tmnxOspfLdpOverRsvp specifies whether LDP-over-RSVP feature is enabled or disabled for a specific OSPF instance. When enabled, OSPF will select the endpoint that is closest to the destination for further selection of LDP-over-RSVP tunnels to that endpoint.

type=boolean
default=false
Displayed(tab/group)=LDP Over RSVP Include (Behavior/OSPFv2)

lfaAugmentRouteTable Specifies whether detailed loopfree-alternate information should be augmented to the route table. The value of this property is valid only when the ospf.Site.loopfreeAlternate and ospf.Site.remoteLoopfreeAlternate have the 'true' value.

type=boolean
default=false
Displayed(tab/group)=Augment Route Table (LFA.General/Loop-free Alternates)

lfaMultiHomeExternalPrefix Specifies whether multi-homed prefix (MHP) loopfree-alternate (LFA) is enabled or not. The value of this property is valid only when the ospf.Site.loopfreeAlternate have 'true' value.

type=boolean
default=false
Displayed(tab/group)=Multi-Homed External Prefix (LFA.General/Loop-free Alternates)

lfaMultiHomeExternalPrefixPreference Specifies multi-homed prefix (MHP) loopfree-alternate (LFA) Preference, If value is 'none(0)', LFA/TI-LFA backup path is preferred over a backup via an alternative prefix-originating router (POI). The value of this property is valid only when the ospf.Site.loopfreeAlternate and ospf.Site.lfaMultiHomeExternalPrefix both have the 'true' value.

type=ospf.LFAMultiHomeExternalPrefixPreferenceType
default=none
Displayed(tab/group)=Preference (LFA.General/Loop-free Alternates)

loopfreeAlternate The value of loopfreeAlternate specifies whether to enable or disable IP fast re-route capability for OSPF.

type=boolean
default=false
Displayed(tab/group)=Loop-free Alternate (LFA.General/Loop-free Alternates)

lsaAccumulate The value of lsaAccumulate defines the accumulation delay for multiple LSA's.

type=int
default=1000
minimum=0
maximum=1000
units=milliseconds
Displayed(tab/group)=LSA Accumulate (Dijkstra/Configuration)

lsaArrivalWait

type=int
default=1000
minimum=0
maximum=600000
units=milliseconds
Displayed(tab/group)=LSA Arrival Wait (Dijkstra/Configuration)

lsaGenerateInitialWait

type=int
default=5000
minimum=10
maximum=600000
units=milliseconds
Displayed(tab/group)=Initial Wait (Dijkstra/Configuration)

lsaGenerateMaxWait

type=int
default=5000
minimum=10
maximum=600000
units=milliseconds
Displayed(tab/group)=LSA Generate Max Wait (Dijkstra/Configuration)

lsaGenerateSecondWait

type=int
default=5000
minimum=10
maximum=600000
units=milliseconds
Displayed(tab/group)=Second Wait (Dijkstra/Configuration)

mappingServerAdminState Specificies the Administrative State of Segment Routing.

type=int
default=3
Displayed(tab/group)=Administrative State (Segment Routing.Mapping Prefix)
enums=
    2: up - Up
    3: down - Down

maxPqCost The value indicates the maximum cost of a destination node during reverse SPF calculation. The maxPqCost is valid only when loopfreeAlternate and remoteLoopfreeAlternate is 'true'.

type=long
default=65535
minimum=0
maximum=4294967295
Displayed(tab/group)=Max PQ Cost (LFA.General/Loop-free Alternates)

maxSrFrrLabels The value of maxSrFrrLabels specifies the maximum number of Segment Routing Fast-Reroute labels. maxSrFrrLabels is valid only when loopfreeAlternate and topologyIndependentLFA is 'true'.

type=int
default=2
minimum=0
maximum=3
Displayed(tab/group)=Max SR-FRR Labels (LFA.General/Loop-free Alternates)

maximumSpfRunTime

type=int
access=read-only
default=0
minimum=0
maximum=2147483647
units=1/100 s
Displayed(tab/group)=Maximum Run Time (Dijkstra/Statistics)

microLoopAvdFibDelay Specifies the time during which the system would continue to use the loop free alternate path when the micro-loops avoidance is enabled.

type=int
default=15
minimum=1
maximum=300
units=deciseconds
Displayed(tab/group)=FIB Delay (Segment Routing.General)

microLoopAvoidance Specifies whether micro-loops avoidance during the convergence is enabled or not. If the value is 'true', the OSPF instance will use the Loop Free SR path for the time specified by the object

type=boolean
default=false
Displayed(tab/group)=Micro-loop Avoidance (Segment Routing.General)

minimumSpfRunTime

type=int
access=read-only
default=0
minimum=0
maximum=2147483647
units=1/100 s
Displayed(tab/group)=Minimum Run Time (Dijkstra/Statistics)

mostRecentExternalSpfRunTime

type=int
access=read-only
default=0
minimum=0
maximum=2147483647
units=1/100 s
Displayed(tab/group)=Most Recent Run Time (Dijkstra/Statistics)

mostRecentFullSpfRunTime

type=int
access=read-only
default=0
minimum=0
maximum=2147483647
units=1/100 s
Displayed(tab/group)=Most Recent Full SPF Run Time (Dijkstra/Statistics)

msdOverrideBaseMplsImposition Specifies the override Base MPLS Imposition (BMI) Maximum Sid Depth (MSD) value that will be announced when Segment Routing is enabled. The value '-1' indicates that the default MSD value will be used. The default MSD value announced is the maximum value the platform supports under ideal conditions.

type=int
default=-1
minimum=-1
maximum=12
Displayed(tab/group)=Override Base MPLS Imposition (Segment Routing.General/Maximum SID Depth)

msdOverrideEntropyReadLabelDepth Specifies the override Entropy Readable Label Depth (ERLD) Maximum Sid Depth (MSD) value that will be announced when Segment Routing is enabled. The value '-1' indicates that the default MSD value will be used. The default MSD value announced is the maximum value the platform supports under ideal conditions.

type=int
default=-1
minimum=-1
maximum=15
Displayed(tab/group)=Override Entropy Readable Label Depth (Segment Routing.General/Maximum SID Depth)

multiInstanceExtension Specifies whether OSPFv2 Multi Instance Extensions are enabled or not for this instance. The value of multiInstanceExtension can only be changed for OSPFv2 instances.

type=boolean
default=false
Displayed(tab/group)=Enable Multi Instance Extensions (Behavior)

multicastImport

type=boolean
default=false
Displayed(tab/group)=Multicast Import (Behavior)

numberOfAreaSites

type=int
access=read-only
default=0

opaqueLsaSupport

type=generic.TruthValue
default=true
Displayed(tab/group)=Opaque LSA Support (Behavior/OSPFv2)

ospf.AreaSite-Set type=Children-Set
ospf.ExportPolicy-Set type=Children-Set
ospf.FlexibleAlgorithm-Set type=Children-Set
ospf.Host-Set type=Children-Set
ospf.IgpShortcutTunnelNextHop-Set type=Children-Set
ospf.ImportPolicy-Set type=Children-Set
ospf.LfaPolicyExclude-Set type=Children-Set
ospf.OspfNeighbor-Set type=Children-Set
ospf.SegmentRoutingAdjacencySet-Set type=Children-Set
ospf.SegmentRoutingMappingServer-Set type=Children-Set
ospf.ShamLink-Set type=Children-Set
ospf.SiteExtension-Set type=Children-Set
ospfAdvRtrCapability The value of ospfAdvRtrCapability specifies the OSPF advertise router capabilities.

type=ospf.OspfAdvRtrCapabTypes
default=disable
Displayed(tab/group)=Advertise Router Capabilities (Behavior)

ospfOperRouterId identifies uniquely the router in the Autonomous System. The default OSPF instance will use the value specified by tmnxOspfRouterId or as one of the router's IPv4 host addresses. For the non-default instances of OSPF, this is the same value as tmnxOspfRouterId (where the default is invalid), which must be specified before the OSPF instance can become operational.

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=OSPF Operational Router ID (/OSPF Instance)

ospfRouterId identifies uniquely the router in the Autonomous System. By default it assumes the value of one of the router's IPv4 host addresses, if IPv4 is configured on the router.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=OSPF Router ID (/OSPF Instance)

ospfRouterIdAddrType

type=rtr.InetAddressType
default=ipv4

overloadAdmininstrativeState

type=boolean
default=false
Displayed(tab/group)=Overload Enabled (Overload)

overloadExt1 Specifies if the OSPF external prefixes with metric-type 1, should be advertised with a maximum metric value when the system goes into overload state for any reason. If the value is 'true', the system uses the maximum metric value.

type=boolean
default=false
Displayed(tab/group)=Overload External Metric-Type 1 (Overload)

overloadExt2 The value of overloadExt2 specifies if the OSPF external prefixes with metric-type 2, should be advertised with a maximum metric value when the system goes into overload state for any reason. If the value is 'true', the system uses the maximum metric value

type=boolean
default=false
Displayed(tab/group)=Overload External Metric-Type 2 (Overload)

overloadInterval

type=int
default=0
minimum=0
maximum=1800
units=seconds
Displayed(tab/group)=Overload Interval (Overload)

overloadLastEnterCode

type=int
access=read-only
default=none
Displayed(tab/group)=Last Overload Entered Code (Overload)
enums=
    1: none - None
    2: spfFailed - SPF Failed
    3: bootOverload - Boot Overload
    4: manualOverload - Manual Overload

overloadLastEnteredTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Overload Entered Time (Overload)

overloadLastExitCode

type=int
access=read-only
default=none
Displayed(tab/group)=Last Overload Exit Code (Overload)
enums=
    1: none - None
    2: bgpSigRecv - BGP Signal Received
    3: timerExpired - Timer Expired
    4: manualExit - Manual Exit

overloadLastExitTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Overload Exit Time (Overload)

overloadOperationalState

type=int
access=read-only
default=noOverload
Displayed(tab/group)=Overload State (Overload)
enums=
    1: overload - Overload
    2: noOverload - No Overload

overloadStubs

type=boolean
default=false
Displayed(tab/group)=Overload Stubs (Overload)

overrideELC Specifies whether received entropy label capability (ELC) advertisement is overridden or not for this OSPF instance.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=Override Entropy Label Capability (/Entropy Label)

prefixSidRangeMax Specifies the maximum local SID index that can be used.

type=long
default=1
minimum=0
maximum=524287
Displayed(tab/group)=Prefix SID Max Index (Segment Routing.General/Prefix SID)

prefixSidStartRange Specifies the local label starting offset value.

type=long
default=0
minimum=0
maximum=524287
Displayed(tab/group)=Prefix SID Start Label (Segment Routing.General/Prefix SID)

prefixSidType Specifies whether local or global operation mode is applicable for SID prefixes.

type=isis.PrefixSIDType
default=none
Displayed(tab/group)=Prefix SID Type (Segment Routing.General/Prefix SID)

processId Identifies a specific process of the OSPF protocol running in the router instance specified by the routerId.

type=long
access=read-create
default=1
minimum=1
maximum=65535
Displayed(tab/group)=Process Id (/OSPF Instance)

redistDelay The value of redistDelay defines the internal OSPF hold down timer for external routes being redistributed into OSPF.

type=int
default=1000
minimum=0
maximum=1000
units=milliseconds
Displayed(tab/group)=Redistribute Delay (Dijkstra/Configuration)

remoteLfaMaxPqNodes Specifies the maximum number of PQ nodes for which we perform the forward SPF check to see if its path to the destination does not go via the node which we are protecting against. The value of remoteLfaMaxPqNodes is only valid when loopfreeAlternate and remoteLoopfreeAlternate both have the value 'true'.

type=int
default=16
minimum=1
maximum=32
Displayed(tab/group)=Max PQ Nodes (LFA.General/Loop-free Alternates)

remoteLfaNodeProtect Specifies whether Node protection with Remote LFA is enabled or not. The value of remoteLfaNodeProtect is only valid when loopfreeAlternate and remoteLoopfreeAlternate have the value 'true'.

type=boolean
default=false
Displayed(tab/group)=Node Protect (LFA.General/Loop-free Alternates)

remoteLoopfreeAlternate The value specifies whether remote-LFA is enabled or not.The remoteLoopfreeAlternate is valid when loopfreeAlternate is 'true'. If loopfreeAlternate is 'false' remote-LFA will also get updated to 'false'.

type=boolean
default=false
Displayed(tab/group)=Remote LFA (LFA.General/Loop-free Alternates)

ribPriorityList Specifies the name of the prefix list from which prefixes are prioritised for fib-download. The prioritised ones are downloaded first to the IOMs. In doing so, the convergence time for these prefixes is better.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=RIB High Priority Prefix List (Behavior/RIB Priority)

rsvpShortcut The value of rsvpShortcut indicates whether RSVP-TE shortcut for resolving IGP routes has been enabled or disabled for OSPF. When the value of rsvpShortcut is set to true RSVP-TE shortcut is enabled and when rsvpShortcut is set to false RSVP-TE shortcut is disabled for OSPF.

DEPRECATED: 17.3 Deprecated from 15.0 R1 for SR 7750/7450/7950 nodes
type=boolean
default=false
Displayed(tab/group)=RSVP Shortcut Enabled (Behavior/OSPFv2)

segmentRoutingAdminState Specifies the Administrative State of Segment Routing.

type=int
default=3
Displayed(tab/group)=Administrative State (Segment Routing.General/States)
enums=
    2: up - Up
    3: down - Down

spfInitialWait

type=int
default=1000
minimum=10
maximum=100000
units=milliseconds
Displayed(tab/group)=Initial Wait (Dijkstra/Configuration)

spfMaxWait

type=int
default=10000
minimum=10
maximum=120000
units=milliseconds
Displayed(tab/group)=SPF Max Wait (Dijkstra/Configuration)

spfRunCount

type=long
access=read-only
default=0
Displayed(tab/group)=Number Of Runs (Dijkstra/Statistics)

spfSecondWait

type=int
default=1000
minimum=10
maximum=100000
units=milliseconds
Displayed(tab/group)=Second Wait (Dijkstra/Configuration)

srlbReservedLabelBlock Specifies the name identifying the reserved label block (SRLB) to be used on this OSPF instance. The SR Local Block (SRLB) Sub-TLV contains the range of labels the node has reserved for local SIDs. When no reserved label block name is specified, no static labels can be allocated. The reserved label block name is defined by the Reserved Label Block under MPLS.

type=Pointer
default=
Displayed(tab/group)=Reserved Label Block (Segment Routing.General)

staticRouteRedistributeMetric

type=int
default=20
minimum=0
maximum=16777214
Displayed(tab/group)=Static Route Metric (/OSPF Redistribution)

staticRouteRedistributeMetricType

type=int
default=type2
Displayed(tab/group)=Static Route Metric Type (/OSPF Redistribution)
enums=
    1: type1 - Type 1
    2: type2 - Type 2

stubRouterSupport

type=boolean
access=read-only
default=true
Displayed(tab/group)=Stub Router Support (/Type)

superBackBone The value of tmnxOspfSuperBackBone specifies whether CE-PE functionality is required or not. tmnxOspfSuperBackBone indicates the type of the LSA generated as a result of routes redistributed into OSPF. When the value is set to 'true' the redistributed routes are injected as summary, external or NSSA LSAs. When the value is set to 'false' the redistributed routes are injected as either external or NSSA LSAs only.

type=generic.TruthValue
default=false
Displayed(tab/group)=Super-Backbone (OSPF Super-Backbone)

suppressDNBit specifies whether to suppress the setting of the DN bit for OSPF LSA packets generated by this instance of OSPF on the router. When suppressDNBit has a value of 'true' the DN bit for OSPF LSA packets generated by this instance of the OSPF router will not be set. When it has a value of 'false' this instance of the OSPF router will follow the normal procedure to determine whether to set the DN bit.

type=boolean
default=false
Displayed(tab/group)=Suppress DN Bit (Behavior)

teAdvertiseDelay Specifies whether advertising the interface delay is enabled or not. If the value is 'true', the OSPF instance will advertise the interface delay in legacy TE TLV attributes, and/or in SR-TE Application Specific Link Attributes (ASLA) when enabled for SR-TE application. The value is only valid when has the value 'true'

type=boolean
default=false
Displayed(tab/group)=Advertise Delay (Behavior/Traffic Engineering)

templateVersionPointer Pointer to the template if this object was created from a template.

type=Pointer
default=
Displayed(tab/group)=Associated Template (Template/Associated Template)

tiLfaNodeProtect Specifies whether Node protection with Topology Independent LFA is enabled or not. The value of tiLfaNodeProtect is only valid when loopfreeAlternate and topologyIndependentLFA have the value 'true'.

type=boolean
default=false
Displayed(tab/group)=Node Protect (LFA.General/Loop-free Alternates)

topologyIndependentLFA The value of topologyIndependentLFA specifies whether Topology Independent LFA is enabled or not. The topologyIndependentLFA is valid only when loopfreeAlternate is 'true'. If loopfreeAlternate is 'false' topologyIndependentLFA will also get updated to 'false'.

type=boolean
default=false
Displayed(tab/group)=Topology Independent LFA (LFA.General/Loop-free Alternates)

trafficEngineeringOptionsSrte Specifies whether the link attributes for the SR-TE application are advertised or not. If the value is 'false' then attributes are not advertised. If the value is 'legacy' then attributes are advertised using TE Opaque LSAs. If the value is 'appSpecificLinkAttr' then attributes are advertised application specific using Extended Link LSAs. The value is only valid when has the value 'true' and when ospf.Site.segmentRoutingAdminState has the value 'inService'."

type=int
default=false
Displayed(tab/group)=SR-TE (Behavior/Traffic Engineering)
enums=
    0: false - False
    1: legacy - Legacy
    2: appSpecificLinkAttr - Application Specific Link Attribute

trafficEngineeringSupport

type=generic.TruthValue
default=true
Displayed(tab/group)=Traffic Engineering Support (Behavior/Traffic Engineering)

tunnelMtuBytes Specifies the tunnel MTU size used for segment routing. The valid range for this property is 0|512..9198. For SR 7x50 nodes from 19.10 onwards the range is 0|512..9786.

type=int
default=0
minimum=0
maximum=9786
Displayed(tab/group)=Tunnel MTU Bytes (Segment Routing.General)

tunnelTablePreference Specifies the preference value for TTM tunnels in this OSPF instance

type=int
default=10
minimum=1
maximum=255
Displayed(tab/group)=Tunnel Table Preference (Segment Routing.General)

unicastImport

type=boolean
default=true
Displayed(tab/group)=Unicast Import (Behavior)

unknownLsaChecksumSum

type=long
access=read-only
default=0
Displayed(tab/group)=Unknown AS-Scope Checksum Sum (Behavior/Link State Advertisements)

unknownLsaCount

type=long
access=read-only
default=0
Displayed(tab/group)=Unknown AS-Scope Count (Behavior/Link State Advertisements)

version

type=ospf.ProtocolVersionEnum
access=read-create
default=v2
Displayed(tab/group)=Version (/OSPF Instance)

vpnDomainId The value of tmnxOspfVpnDomainId specifies the OSPF VPN Domain. This is exchanged using BGP in the extended community attribute associated with a prefix. This object applies to VPRN instances of OSPF only. An attempt to modify the value of this object will result in an 'inconsistentValue' error when the vRtrID index for this row entry is not a VPRN instance.

type=string
default=0000.0000.0000
minimum=0
maximum=14
units=hex
Displayed(tab/group)=VPN Domain ID (OSPF Super-Backbone)

vpnDomainType The value of tmnxOspfVpnDomainType specifies type of the extended community attribute exchanged using BGP to carry the OSPF VPN Domain ID. This object applies to VPRN instances of OSPF only. An attempt to modify the value of this object will result in an 'inconsistentValue' error when the vRtrID index for this row entry is not a VPRN instance.

type=ospf.VpnDomainTypes
default=type0000
Displayed(tab/group)=VPN Domain Type (OSPF Super-Backbone)

vpnTag The value of tmnxOspfVpnTag specifies the route tag for an OSPF VPN on a PE router. This field is set in the tag field of the OSPF external LSAs generated by the PE. This is mainly used to prevent routing loops. This object applies to VPRN instances of OSPF only. An attempt to modify the value of this object will result in an 'inconsistentValue' error when the vRtrID index for this row entry is not a VPRN instance

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=VPN Tag (OSPF Super-Backbone)

vrfName The name of the VPRN site when OSPF 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=ospfDown

displayedName

default=OSPF

operationalState

default=ospfSiteDisabled

 
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 inherited from rtr.ProtocolSite
shutDown, turnUp
 
Supported Network Elements
7450 ESS
7210 SAS M Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS T Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS K Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS Mxp Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS S/Sx
7210 SAS X
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7701 CPAA
OS6850/6850E
OS6855
7705 SAR
7705 SAR H
OS9700E/9800E
Wavence SM
Generic NE 1.0.0
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6360
OS6465
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Product Specifics
7210 SAS E (all versions)
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R (all versions)
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx (all versions)
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T (all versions)
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7210 SAS X (all versions)
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS (all versions)
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7701 CPAA (all versions)
7701 CPAA 8.0
7705 SAR Gen 2 (all versions)
7705 SAR Gen 2 25.0
7705 SAR H (all versions)
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR Hm (all versions)
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR (all versions)
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR (all versions)
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS (all versions)
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 (all versions)
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 5.0
DC VSA8 6.0
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
Generic NE 1.0.0
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6465 (all versions)
OS6465 8.10
OS6465 8.10
OS6465 8.6
OS6465 8.7
OS6465 8.8
OS6465 8.8
OS6465 8.9
OS6465 8.9
OS6465 8.9
OS6560/OS6560E (all versions)
OS6560/OS6560E 8.10
OS6560/OS6560E 8.10
OS6560/OS6560E 8.6
OS6560/OS6560E 8.7
OS6560/OS6560E 8.8
OS6560/OS6560E 8.8
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6570M (all versions)
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6850/6850E (all versions)
OS6850/6850E 6.4.2
OS6850/6850E 6.4.3
OS6850/6850E 6.4.4
OS6850/6850E 6.4.5
OS6850/6850E 6.4.6
OS6855 (all versions)
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
OS6860E/OS6860N (all versions)
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.6
OS6860E/OS6860N 8.7
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6865 (all versions)
OS6865 8.10
OS6865 8.10
OS6865 8.6
OS6865 8.7
OS6865 8.8
OS6865 8.8
OS6865 8.9
OS6865 8.9
OS6865 8.9
OS6870 (all versions)
OS6870 8.10
OS6900 (all versions)
OS6900 8.10
OS6900 8.10
OS6900 8.6
OS6900 8.7
OS6900 8.8
OS6900 8.8
OS6900 8.9
OS6900 8.9
OS6900 8.9
OS9700E/9800E (all versions)
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6
Wavence SM 19A.0.0
Wavence SM 20A.0.0
Wavence SM 21A.0.0
Wavence SM 22.0.0
Wavence SM 22A.0.0
Wavence SM 23.0.0
Wavence SM 23A.0.0
Wavence SM 24.0.0
Wavence SM 25.0.0