Class ospf:ADom (ABSTRACT)

Class ID:5793
Class Label: Domain
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, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

An abstraction of an OSPF domain (VRF).

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: l3:ProtDom,
Sub Mos: ospf:Dom, ospfv3:Dom,


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:ADom An abstraction of an OSPF domain (VRF).
 
 
 
 
 
 
 ├
[V] ospf:Dom The per OSPF domain (vrf) information.
 
 
 
 
 
 
 ├
[V] ospfv3:Dom The OSPF domain (VRF) information.


Events
                


Faults
                ospf:ADom:MaxEcmpExceeded


Fsms
                


Properties Summary
Defined in: ospf:ADom
ospf:BwRef
          scalar:Uint32
bwRef  (ospf:ADom:bwRef)
           The ISIS domain bandwidth reference. This property sets the default reference bandwidth used for calculating the ISIS cost metric.
ospf:DomControl
          scalar:Bitmask8
ctrl  (ospf:ADom:ctrl)
           The control state.
ospf:Dist
          scalar:UByte
dist  (ospf:ADom:dist)
           The preferred ISIS Domain level administrative distance.
ospf:EcmpOperSt
          scalar:Enum8
ecmpOperSt  (ospf:ADom:ecmpOperSt)
           Operational State of Max ECMP
ospf:FailStQual
          scalar:Bitmask64
failStQual  (ospf:ADom:failStQual)
           The OSPF domain failed state qualifier.
ospf:DomFlags
          scalar:Bitmask16
flags  (ospf:ADom:flags)
           The IP address flags.
ospf:Ecmp
          scalar:UByte
maxEcmp  (ospf:ADom:maxEcmp)
           The maximum number of equal-cost paths for BGP load sharing.
ospf:OperSt
          scalar:Enum8
operSt  (ospf:ADom:operSt)
           The runtime state of the object or policy.
ip:RtrId
          address:IPv4
rtrId  (ospf:ADom:rtrId)
           The BGP router ID.
rtmap:RouteTag
          scalar:Uint32
selfAdvRtTag  (ospf:ADom:selfAdvRtTag)
           NO COMMENTS
Defined in: nw:CpDom
naming:Name
          string:Basic
name  (nw:CpDom:name)
           Overrides:nw:Conn:name
           The name of the object.
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.
Properties Detail

bwRef

Type: ospf:BwRef
Primitive Type: scalar:Uint32

Units: Mbps
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The ISIS domain bandwidth reference. This property sets the default reference bandwidth used for calculating the ISIS cost metric.
Constants
defaultValue 40000u --- NO COMMENTS





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





ctrl

Type: ospf:DomControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
pfx-suppress 1 Prefix suppression Prefix suppression
name-lookup 2 Enable name lookup for router IDs name loopup
defaultValue 0 --- NO COMMENTS





dist

Type: ospf:Dist
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The preferred ISIS Domain level administrative distance.
Constants
defaultValue 110 --- 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.



ecmpOperSt

Type: ospf:EcmpOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational State of Max ECMP
Constants
ok 0 ok Operating normally
thresh-exceeded 1 Threshold Exceeded Threshold exceeded
DEFAULT ok(0) ok Operating normally





failStQual

Type: ospf:FailStQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The OSPF domain failed state qualifier.
Constants
unspecified 0ull Unspecified Unspecified
ipc-error 16ull IPC error IPC error
init-error 1ull Initialization error Initialization error
ha-error 2ull HA error HA error
rib-error 32ull RIB programming error RIB error
proto-error 4ull Protocol error Protocol error
mtu-mismatch 64ull Mtu Mismatch config error MTU-Mismatch
mem-error 8ull Memory error Memory error
DEFAULT unspecified(0ull) Unspecified Unspecified





flags

Type: ospf:DomFlags
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IP address flags.
Constants
unspecified 0 Unspecified Unspecified
abr-self 1 ABR self Local node is ABR
asbr-self 2 ASBR self Local node is ASBR
DEFAULT unspecified(0) Unspecified Unspecified





maxEcmp

Type: ospf:Ecmp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The maximum number of equal-cost paths for BGP load sharing.
Constants
defaultValue 8 --- 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.



operSt

Type: ospf:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
down 0 Down The state is down
up 1 Up The state is up
failed 2 Failed The state is fail
DEFAULT up(1) Up The state is up





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.



rtrId

Type: ip:RtrId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The BGP router ID.



selfAdvRtTag

Type: rtmap:RouteTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 4294967295u --- NO COMMENTS





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.