Class hcospf:Area (CONCRETE)

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

This object holds ospf information that is operated at a interface level

Naming Rules
RN FORMAT: area-{id}

    [1] PREFIX=area- PROPERTY = id




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/ospf/inst-{name}/dom-{name}/area-{id}

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/ospf/inst-{name}/dom-{name}/area-{id}

                


Diagram

Super Mo: hcospf:AArea,
Container Mos: hcospf:Dom (deletable:no),


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] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[V] hcloud:Account 
 
 
 
 ├
[V] hcloud:Region 
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 
 
 ├
[V] hcospf:Entity  Holds ospf control plane entity information
 
 
 
 
 
 
 
 ├
[V] hcospf:Inst  This objects hold per ospf instance information
 
 
 
 
 
 
 
 
 ├
[V] hcospf:Dom  This objects hold per ospf domain (vrf) information
 
 
 
 
 
 
 
 
 
 ├
[V] hcospf:Area  This object holds ospf information that is operated at a 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] hcloud:Account 
 
 ├
[V] hcloud:Region 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 ├
[V] hcospf:Entity  Holds ospf control plane entity information
 
 
 
 
 
 ├
[V] hcospf:Inst  This objects hold per ospf instance information
 
 
 
 
 
 
 ├
[V] hcospf:Dom  This objects hold per ospf domain (vrf) information
 
 
 
 
 
 
 
 ├
[V] hcospf:Area  This object holds ospf information that is operated at a interface level


Contained Hierarchy
[V] hcospf:Area  This object holds ospf information that is operated at a interface level


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] hcospf:AArea  This object holds ospf information that is operated at the area level
 
 
 
 
 
 
 ├
[V] hcospf:Area  This object holds ospf information that is operated at a interface level


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hcospf:Area
hcospf:AreaId
          address:IPv4
id  (hcospf:Area:id)
           Overrides:hcospf:AArea:id
           An object identifier.
Defined in: hcospf:AArea
hcospf:AreaCost
          scalar:Uint32
cost  (hcospf:AArea:cost)
           The OSPF Area cost for the default summary LSAs. The Area cost is used with NSSA and stub area types only.
hcospf:AreaControl
          scalar:Bitmask8
ctrl  (hcospf:AArea:ctrl)
           The control state.
hcospf:AreaT
          scalar:Enum8
type  (hcospf: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

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: hcospf: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: hcospf: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: hcospf:AreaId
Primitive Type: address:IPv4

Overrides:hcospf:AArea:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
An object identifier.
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





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.



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: hcospf: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