Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class ospf:AIf (ABSTRACT)

Class ID:5798
Class Label: Interface
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: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

An abstraction of the OSPF information that is operated at an interface level.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: l3:ProtIf,
Sub Mos: ospf:If, ospfv3:If,
Relations From: nw:PathEp,
Relations: nw:RtPathToIf,


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:Ep A static endpoint.
 
 		 
 		 ├
 		[V] nw:ConnEp A connection endpoint abstraction.
 
 		 
 		 
 		 ├
 		[V] nw:If The interface information.
 
 		 
 		 
 		 
 		 ├
 		[V] nw:LogicalIf A logical interface abstraction.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] nw:ProtIf A protocol interface abstraction.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] l3:ProtIf A layer 3 protocol interface abstraction.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ospf:AIf An abstraction of the OSPF information that is operated at an interface level.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ospf:If The OSPF information that is operated at an interface level.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ospfv3:If An OSPF interface.


Events


Faults 
                ospf:AIf:P2PError


Fsms


Properties Summary
Defined in: ospf:AIf
address:Ip addr  (ospf:AIf:addr)
           The peer IP address.
ospf:AreaId
          address:IPv4 		area  (ospf:AIf:area)
           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.
address:Ip bdr  (ospf:AIf:bdr)
           The OSPF backup designated router IP address.
ip:RtrId
          address:IPv4 		bdrId  (ospf:AIf:bdrId)
           A backup designated router ID.
ospf:IfCost
          scalar:Uint16 		cost  (ospf:AIf:cost)
           The OSPF Area cost for the default summary LSAs. The Area cost is used with NSSA and stub area types only.
ospf:IfControl
          scalar:Bitmask8 		ctrl  (ospf:AIf:ctrl)
           The control state.
ospf:DeadIntvl
          scalar:Uint16 		deadIntvl  (ospf:AIf:deadIntvl)
           The interval between hello packets from a neighbor before the router declares the neighbor as down. This value must be the same for all networking devices on a specific network. Specifying a smaller dead interval (seconds) will give faster detection of a neighbor being down and improve convergence, but might cause more routing instability.
address:Ip dr  (ospf:AIf:dr)
           A designated router address.
ip:RtrId
          address:IPv4 		drId  (ospf:AIf:drId)
           A designated router ID.
ospf:FailStQual
          scalar:Bitmask64 		failStQual  (ospf:AIf:failStQual)
           The OSPF domain failed state qualifier.
ospf:IfFlags
          scalar:Bitmask32 		flags  (ospf:AIf:flags)
           The IP address flags.
ospf:HelloIntvl
          scalar:Uint16 		helloIntvl  (ospf:AIf:helloIntvl)
           The hello interval.
ospf:LsaCksumSum
          scalar:Uint32 		lsaCksumSum  (ospf:AIf:lsaCksumSum)
           The LSA checksum sum.
ospf:NwT
          scalar:Enum8 		nwT  (ospf:AIf:nwT)
           The OSPF interface policy network type. OSPF supports point-to-point and broadcast.
ospf:IfCost
          scalar:Uint16 		operCost  (ospf:AIf:operCost)
           The route summary cost.
ospf:IfOperSt
          scalar:Enum8 		operSt  (ospf:AIf:operSt)
           The runtime state of the object or policy.
ospf:P2PIfOperSt
          scalar:Enum8 		p2pOperSt  (ospf:AIf:p2pOperSt)
           P2P Interface Operational state
ospf:IfPfxSuppress
          scalar:Enum8 		pfxSuppress  (ospf:AIf:pfxSuppress)
           Configure prefix suppression
ospf:DesigPrio
          scalar:UByte 		prio  (ospf:AIf:prio)
           The QoS priority class ID.
ospf:RexmitIntvl
          scalar:Uint16 		rexmitIntvl  (ospf:AIf:rexmitIntvl)
           The interval between LSA retransmissions. The retransmit interval occurs while the router is waiting for an acknowledgement from the neighbor router that it received the LSA. If no acknowlegment is received at the end of the interval, then the LSA is resent.
ospf:IfType
          scalar:Enum8 		type  (ospf:AIf:type)
           The specific type of the object or component.
ospf:XmitDelay
          scalar:Uint16 		xmitDelay  (ospf:AIf:xmitDelay)
           The delay time needed to send an LSA update packet. OSPF increments the LSA age time by the transmit delay amount before transmitting the LSA update. You should take into account the transmission and propagation delays for the interface when you set this value.
Defined in: nw:ProtIf
nw:IfAdminSt
          scalar:Enum8 		adminSt  (nw:ProtIf:adminSt)
           The administrative state of the object or policy.
Defined in: nw:If
naming:Descr
          string:Basic 		descr  (nw:If:descr)
          
nw:IfId
          base:IfIndex 		id  (nw:If:id)
           An identifier .
Defined in: nw:Ep
naming:Name
          string:Basic 		name  (nw:Ep: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

addr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The peer IP address.


adminSt

Type: nw:IfAdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled




area

Type: ospf:AreaId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: implicit
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




bdr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The OSPF backup designated router IP address.


bdrId

Type: ip:RtrId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A backup designated router ID.


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:IfCost
Primitive Type: scalar:Uint16

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
unspecified 0 Unspecified NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS




ctrl

Type: ospf:IfControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
unspecified 0 Unspecified Unspecified
passive 1 Passive participation Passive, the interface doesn't participate in OSPF protocol and will not establish adjacencies or send routing updates. However the interface is announced as part of the routing network
mtu-ignore 2 MTU ignore MTU ignore, disables MTU mismatch detection on an interface.
advert-subnet 4 Advertise subnet Advertise ip subnet instead of a host mask in the router LSA
bfd 8 BFD Bidirectional Forwarding Detection
DEFAULT unspecified(0) Unspecified Unspecified




deadIntvl

Type: ospf:DeadIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The interval between hello packets from a neighbor before the router declares the neighbor as down. This value must be the same for all networking devices on a specific network. Specifying a smaller dead interval (seconds) will give faster detection of a neighbor being down and improve convergence, but might cause more routing instability.
Constants
defaultValue 40 --- NO COMMENTS




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    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.


dr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A designated router address.


drId

Type: ip:RtrId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A designated router ID.


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:IfFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IP address flags.
Constants
unspecified 0u Unspecified Unspecified
admin-up 1u Admin up Admin up
proto-up 2u Proto up Proto up
DEFAULT unspecified(0u) Unspecified Unspecified




helloIntvl

Type: ospf:HelloIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The hello interval.
Constants
defaultValue 10 --- NO COMMENTS




id

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
An identifier .


lsaCksumSum

Type: ospf:LsaCksumSum
Primitive Type: scalar:Uint32

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


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.


nwT

Type: ospf:NwT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The OSPF interface policy network type. OSPF supports point-to-point and broadcast.
Constants
unspecified 0 Unspecified Unspecified
p2p 1 Point-to-point p2p interface
bcast 2 Broadcast Broadcast interface
DEFAULT unspecified(0) Unspecified Unspecified




operCost

Type: ospf:IfCost
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The route summary cost.
Constants
unspecified 0 Unspecified NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS




operSt

Type: ospf:IfOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 Unknown Unknown state
down 1 Down Down state
loopback 2 Loopback Loopback state
waiting 3 Waiting Waiting state
p2p 4 p2p p2p state
dr 5 DR DR state
bdr 6 BDR BDR state
dr-other 7 DR-other DROther state
DEFAULT down(1) Down Down state




p2pOperSt

Type: ospf:P2PIfOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
P2P Interface Operational state
Constants
ok 0 ok Operating normally
nbr-exceeded 1 Neighbors limit on P2P interface exceeded Neighbor limit exceeded
DEFAULT ok(0) ok Operating normally




pfxSuppress

Type: ospf:IfPfxSuppress
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Configure prefix suppression
Constants
inherit 0 Inherit Inherit
enable 1 Enable Enable
disable 2 Disable Disable
DEFAULT inherit(0) Inherit Inherit




prio

Type: ospf:DesigPrio
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The QoS priority class ID.
Constants
defaultValue 1 --- NO COMMENTS




rexmitIntvl

Type: ospf:RexmitIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The interval between LSA retransmissions. The retransmit interval occurs while the router is waiting for an acknowledgement from the neighbor router that it received the LSA. If no acknowlegment is received at the end of the interval, then the LSA is resent.
Constants
defaultValue 5 --- 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:IfType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
unspecified 0 Unspecified Unspecified
loopback 1 Loopback Loopback type
p2p 2 P2P p2p type
p2mp 3 P2MP p2mp type
nbma 4 NBMA nbma type
bcast 5 Broadcast BDR state
DEFAULT unspecified(0) Unspecified Unspecified




xmitDelay

Type: ospf:XmitDelay
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The delay time needed to send an LSA update packet. OSPF increments the LSA age time by the transmit delay amount before transmitting the LSA update. You should take into account the transmission and propagation delays for the interface when you set this value.
Constants
defaultValue 1 --- NO COMMENTS






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail