ospf
AreaSite

OSPF uses areas to simplify network management and scalability by partitioning the network into these smaller regions.



public class AreaSite

Stats:
ospf.AreaBasicStats ospf.AreaSiteLfaStats ospf.AreaSiteSegmentRoutingLfaStats

Properties
activeInterfaces

type=int
access=read-only
default=0
Displayed(tab/group)=Active Interfaces (Counters/Counters)

adjacencyCheck This specifies whether or not adjacency checks shall be performed for the NSSA. If the value is 'false', then no checks are done. If the value is 'true', then adjacency checks will be done.

type=boolean
default=false
Displayed(tab/group)=Adjacency Check (Stub/NSSA/NSSA)

areaAdvRtrCapability The value of areaAdvRtrCapability specifies whether or not advertise-router-capabilities are enabled at area level.

type=boolean
default=true
Displayed(tab/group)=Enable Advertise Router Capability

areaBorderRouterCount

type=int
access=read-only
default=0
Displayed(tab/group)=Area Border Router Count (Counters)

areaExtendedLsa Specifies the whether or not to use extended LSA's for this OSPFv3 area.

type=ospf.AreaExtendedLsaType
default=0
Displayed(tab/group)=Extended LSA

areaId

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=Area ID

areaIdAddrType

type=rtr.InetAddressType
access=read-create
default=ipv4

areaInstanceIndex

type=int
Displayed(tab/group)=Area Index
enums=
    0: 0
    1: 1
    2: 2
    3: 3

areaKeyRolloverInterval Specifies the time after which a key rollover will start.

type=int
default=10
minimum=10
maximum=300
units=seconds
Displayed(tab/group)=Key Rollover Interval

areaSummary

type=int
access=read-only
default=sendAreaSummary
Displayed(tab/group)=Import Summary (Stub/NSSA)
enums=
    1: noAreaSummary - No Area Summary
    2: sendAreaSummary - Send Area Summary

areaType

type=ospf.AreaType
default=standard
Displayed(tab/group)=Type

autonomousSystemBorderRouterCount

type=int
access=read-only
default=0
Displayed(tab/group)=AS Border Router Count (Counters)

bierTemplate Specifies the BIER template name as defined by bier.BierTemplate.templateName for OSPF level.

type=string
default=
Displayed(tab/group)=Template (/BIER)

bierTemplateAdminState Specifies the administrative state of the template specified by the object "bierTemplate" for OSPF level.

type=netw.AdministrativeState
default=ospfAreaDown
Displayed(tab/group)=Administrative State (/BIER)

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)

databaseExportExclude Specifies whether database export is explicitly disabled or not for this OSPF area. If the value is 'true', database export is disabled for this OSPF area. If the value is 'false', this area inherits the configuration from the instance level; i.e. if databaseExport is 'enabled' for the OSPF instance, then database export is enabled for this area.

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

defaultCost

type=int
default=10
minimum=0
maximum=16777215
Displayed(tab/group)=ABR Default Route Cost

dnsOpaqueLsa

type=ospf.YesNo
default=yes
Displayed(tab/group)=DNS Opaque LSAs Distributed

hasProblem

type=boolean
access=read-only
default=false
Displayed(tab/group)=RCA Audit Problem(s) (/RCA)

importAsExtern

type=int
access=read-only
default=importExternal
Displayed(tab/group)=Import AS Extern
enums=
    1: importExternal - Import External
    2: importNoExternal - Import No External
    3: importNssa - Import NSSA

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

type=long
access=read-only
default=0
Displayed(tab/group)=Instance ID

lastAuditTime Time of last running the RCA Audit of this object.

type=Date
access=read-only
Displayed(tab/group)=Last Audit Time (/RCA)

lastSpfRunTime

type=Date
access=read-only
default=0

loopfreeAlternateExclude The value of loopfreeAlternateExclude specifies whether or not the OSPF area should be excluded during LFA calculations. The value of loopfreeAlternateExclude is only valid when OSPF Site loopfreeAlternate has a value of 'true'.

type=boolean
default=false
Displayed(tab/group)=Loop-free Alternate Exclude

lsaChecksumSum Checksum of all AS-scoped LSAs in the database.

type=int
access=read-only
default=0
Displayed(tab/group)=LSA Checksum Sum

metric

type=int
default=1
minimum=1
maximum=16777215
Displayed(tab/group)=Default Cost (Stub/NSSA/Stub)

metricType

type=int
default=ospfMetric
Displayed(tab/group)=MetricType (Stub/NSSA/Stub)
enums=
    1: ospfMetric
    2: comparableCost
    3: nonComparable

nodeDiscoveryProfile Specifies the name of the Network Element (NE) Profile to be used for node discovering. The NE information from the profile will be advertised via type 10 Opaque LSA. This property is applicable only under VPRN context. The can be associated only if it has a non-default netw.NodeDiscoveryProfile.networkElementId and either of its netw.NodeDiscoveryProfile.networkIP4Address or netw.NodeDiscoveryProfile.networkIP6Address has a non-default value.

type=string
default=
Displayed(tab/group)=Advertise Node Discovery Profile

nssaRedistribute

type=boolean
default=true
Displayed(tab/group)=Redistribute External Routes (Stub/NSSA/NSSA)

nssaTranslate

type=ospf.OptNssaTranslateType
default=candidate
Displayed(tab/group)=NSSA Router Translation

nssaTranslatorRole

type=int
access=read-only
default=candidate
Displayed(tab/group)=Translator Role (Stub/NSSA/NSSA)
enums=
    1: always - Always
    2: candidate - Candidate

nssaTranslatorStabilityInterval

type=int
access=read-only
default=40
Displayed(tab/group)=Translator Stability Interval (Stub/NSSA/NSSA)

nssaTranslatorState

type=int
access=read-only
default=disabled
Displayed(tab/group)=Translator State (Stub/NSSA/NSSA)
enums=
    0: unknown - Unknown
    1: enabled - Enabled
    2: elected - Elected
    3: disabled - Disabled

originateDefault Specifies whether or not when configuring an NSSA with no summaries, the Area Border Router (ABR) will inject a type-7 LSA default route into the NSSA area. The default behavior is to inject a type-3 LSA default route, but some older implementations expect a type-7 LSA default route. When the value is 'originateType7', type-7 LSA default routes are injected into an NSSA configured with no summaries. When the value is 'originateType3', type-3 LSA default routes are injected into an NSSA configured with no summaries. When the value is 'noOriginate', no default routes are generated. The 'adjacencyCheck' value is applicable only when this property has value other than 'noOriginate'.

type=int
default=noOriginate
Displayed(tab/group)=Originate Default Route (Stub/NSSA/NSSA)
enums=
    1: noOriginate
    2: originateType3
    3: originateType7

ospf.AdvertisedRange-Set type=Children-Set
ospf.AreaExportPolicy-Set type=Children-Set
ospf.AreaImportPolicy-Set type=Children-Set
ospf.Interface-Set type=Children-Set
ospf.LsaCounter-Set type=Children-Set
ospf.OspfNeighbor-Set type=Children-Set
ospf.VirtualLink-Set type=Children-Set
rangeBlackhole

type=boolean
default=true
Displayed(tab/group)=Blackhole Range

rca.Problem-Set type=Children-Set
serviceId

type=long
access=read-only
default=0

serviceType

type=service.ServiceType
access=read-only
default=unknown

stubSupport Applicable to AOS nodes only.

type=boolean
default=false
Displayed(tab/group)=Stub Support (Stub/NSSA/Stub)

subscriberId

type=long
access=read-only
default=0

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

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

totalInterfaces

type=int
access=read-only
default=0
Displayed(tab/group)=Total Interfaces (Counters/Counters)

totalVirtualLinks

type=int
access=read-only
default=0
Displayed(tab/group)=Total Virtual Links (Counters/Counters)

unknownLsaChecksumSum

type=int
access=read-only
default=0

version

type=int
access=read-only
default=2
Displayed(tab/group)=Version

virtualLinkIp

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Virtual Link IP

virtualLinkIpAddrType

type=rtr.InetAddressType
access=read-only
default=ipv4

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

wavekeyOpaqueLsa

type=ospf.YesNo
default=yes
Displayed(tab/group)=Wave Key Opaque LSAs Distributed

  
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
 
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
7705 SAR
7705 SAR H
Generic NE 1.0.0
OS9700E/9800E
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6360
OS6465
OS6850/6850E 6.4.4
OS6850/6850E 6.4.5
OS6850/6850E 6.4.6
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
Wavence SM
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Product Specifics
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 (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)
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 (all versions)
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 6.4.4
OS6850/6850E 6.4.5
OS6850/6850E 6.4.6
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