Class ospf:Area (CONCRETE)

Class ID:2664
Class Label: Area
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The OSPF information that operates at an interface level.

Naming Rules
RN FORMAT: area-{id}

    [1] PREFIX=area- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ospf/inst-{name}/dom-{name}/area-{id}

[1] sys/ospf/inst-{name}/dom-{name}/area-{id}

                


Diagram

Super Mo: ospf:AArea,
Container Mos: ospf:Dom (deletable:no),
Contained Mos: ospf:AreaStats, ospf:Db, ospf:DefRtLeakP, ospf:InterAreaRtSum, ospf:LsaLeakCtrlP, ospf:LsaLeakP,
Relations From: ospf:ExtDef,
Relations: ospf:RtExtDefToOspfArea,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] ospf:Entity The OSPF control plane entity information.
 
 
 
 
 
 ├
[V] ospf:Inst The per OSPF instance information.
 
 
 
 
 
 
 ├
[V] ospf:Dom The per OSPF domain (vrf) information.
 
 
 
 
 
 
 
 ├
[V] ospf:Area The OSPF information that operates at an interface level.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] ospf:Entity The OSPF control plane entity information.
 
 
 ├
[V] ospf:Inst The per OSPF instance information.
 
 
 
 ├
[V] ospf:Dom The per OSPF domain (vrf) information.
 
 
 
 
 ├
[V] ospf:Area The OSPF information that operates at an interface level.


Contained Hierarchy
[V] ospf:Area The OSPF information that operates at an interface level.
 ├
[V] ospf:AreaStats The OSPF area-related statistics.
 ├
[V] ospf:Db The OSPF database information.
 
 ├
[V] ospf:LsaRec The LSA records information.
 
 ├
[V] ospf:Route The OSPF route information is used to establish OSPF sessions between peers.
 
 
 ├
[V] ospf:McNexthop The OSPF Multicast Nexthop information.
 
 
 ├
[V] ospf:UcNexthop The Unicast Nexthop information.
 ├
[V] ospf:DefRtLeakP The default route leak policy information.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] ospf:InterAreaRtSum The inter-area route summarization. This is configured on ABRs, summarizing routes between areas in the autonomous system.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] ospf:LsaLeakCtrlP  Lsa Leak Control concrete class.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] ospf:LsaLeakP The link-state advertisement (LSA) leak policy.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] ospf:RtExtDefToOspfArea 


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:CpDom A control plane domain abstraction. This object represents a domain within a control plane instance. For example, a VRF.
 
 
 
 ├
[V] nw:ProtDom A protocol domain abstraction.
 
 
 
 
 ├
[V] l3:ProtDom A layer 3 protocol domain abstraction.
 
 
 
 
 
 ├
[V] ospf:AArea An abstraction of the OSPF information that is operated on at a interface level.
 
 
 
 
 
 
 ├
[V] ospf:Area The OSPF information that operates at an interface level.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: ospf:Area
ospf:AreaId
          address:IPv4
id  (ospf:Area:id)
           Overrides:ospf:AArea:id
           The OSPF Area ID. An area is a logical collection of OSPF networks, routers, and links that have the same area identification. A router within an area must maintain a topological database for the area to which it belongs. The router doesn't have detailed information about network topology outside of its area, thereby reducing the size of its database. Areas limit the scope of route information distribution. It is not possible to do route update filtering within an area. The link-state database (LSDB) of routers within the same area must be synchronized and be exactly the same; however, route summarization and filtering is possible between different areas. The main benefit of creating areas is a reduction in the number of routes to propagate-by the filtering and the summarization of routes. Areas are identified by an area ID. Cisco IOS software supports area IDs expressed in IP address format or decimal format, for example, area 0.0.0.0 is equal to area 0.
Defined in: ospf:AArea
ospf:AsbrCnt
          scalar:Uint32
asbrCnt  (ospf:AArea:asbrCnt)
           An AS border router count.
ospf:BrCnt
          scalar:Uint32
brCnt  (ospf:AArea:brCnt)
           A border router count.
ospf:AreaCost
          scalar:Uint32
cost  (ospf:AArea:cost)
           The OSPF Area cost for the default summary LSAs. The Area cost is used with NSSA and stub area types only.
ospf:AreaControl
          scalar:Bitmask8
ctrl  (ospf:AArea:ctrl)
           The control state.
ospf:LsaCksumSum
          scalar:Uint32
lsaCksumSum  (ospf:AArea:lsaCksumSum)
           The LSA checksum sum.
ospf:NssaTransRole
          scalar:Enum8
nssaTransRole  (ospf:AArea:nssaTransRole)
           A not-so-stubby area translator role.
ospf:NssaTransSt
          scalar:Enum8
nssaTransSt  (ospf:AArea:nssaTransSt)
           An not-so-stubby area translator state.
ospf:NssaTransStabIntvl
          scalar:Uint32
nssaTransStabIntvl  (ospf:AArea:nssaTransStabIntvl)
           An not-so-stubby area translator stability interval.
ospf:AreaT
          scalar:Enum8
type  (ospf:AArea:type)
           The specific type of the object or component.
Defined in: nw:CpDom
naming:Name
          string:Basic
name  (nw:CpDom:name)
           Overrides:nw:Conn:name
           The name of the object.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Properties Detail

asbrCnt

Type: ospf:AsbrCnt
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
An AS border router count.



brCnt

Type: ospf:BrCnt
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A border router count.



childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





cost

Type: ospf:AreaCost
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The OSPF Area cost for the default summary LSAs. The Area cost is used with NSSA and stub area types only.
Constants
defaultValue 1u --- NO COMMENTS





ctrl

Type: ospf:AreaControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
unspecified 0 Unspecified Unspecified
summary 1 Originate summary LSA ABRs Originate summary LSAs into other areas. Typically it is off in stubby areas (stub/nssa area). This knob is isued to turn on generating summary lsas into stub/ nssa areas
redistribute 2 Send redistributed LSAs into NSSA area Redistribution enabled, used with nssa areas only. Send redistributed LSAs into nssa area
suppress-fa 4 Suppress forwarding address in translated LSA LSA translation policy, suppress forwarding address in type7-type5 translated LSAs
defaultValue (2|1) --- NO COMMENTS





dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



id

Type: ospf:AreaId
Primitive Type: address:IPv4

Overrides:ospf:AArea:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The OSPF Area ID. An area is a logical collection of OSPF networks, routers, and links that have the same area identification. A router within an area must maintain a topological database for the area to which it belongs. The router doesn't have detailed information about network topology outside of its area, thereby reducing the size of its database. Areas limit the scope of route information distribution. It is not possible to do route update filtering within an area. The link-state database (LSDB) of routers within the same area must be synchronized and be exactly the same; however, route summarization and filtering is possible between different areas. The main benefit of creating areas is a reduction in the number of routes to propagate-by the filtering and the summarization of routes. Areas are identified by an area ID. Cisco IOS software supports area IDs expressed in IP address format or decimal format, for example, area 0.0.0.0 is equal to area 0.
Constants
backbone 0u Backbone area NO COMMENTS
defaultValue 1u --- NO COMMENTS





lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





lsaCksumSum

Type: ospf:LsaCksumSum
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The LSA checksum sum.



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of the object.



nssaTransRole

Type: ospf:NssaTransRole
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A not-so-stubby area translator role.
Constants
always 1 Always Always
candidate 2 Candidate Candidate
DEFAULT candidate(2) Candidate Candidate





nssaTransSt

Type: ospf:NssaTransSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
An not-so-stubby area translator state.
Constants
enabled 1 Enabled Enabled
elected 2 Elected Elected
disabled 3 Disabled Disabled
DEFAULT elected(2) Elected Elected





nssaTransStabIntvl

Type: ospf:NssaTransStabIntvl
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
An not-so-stubby area translator stability interval.
Constants
defaultValue 40u --- NO COMMENTS





rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.






type

Type: ospf:AreaT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
regular 1 Regular area Regular area
stub 2 Stub area Stub area
nssa 3 NSSA area NSSA area
DEFAULT nssa(3) NSSA area NSSA area