Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class ospf:IfDef (CONCRETE)

Class ID:1423
Class Label: Interface Profile Definition
Encrypted: true - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The OSPF interface definition model.

Naming Rules 
RN FORMAT: ospfIfP

    [1] PREFIX=ospfIfP


DN FORMAT: 

        Too Many Containers: 258


Containers Hierarchies
Too Many containers: 258


Contained Hierarchy
[V] ospf:IfDef The OSPF interface definition model.
 ├
 		[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:AuthKeyDef  Encrypted Password
 ├
 		[V] ospf:RsIfDefToOspfIf A source relation to the OSPF information that is operated at an interface level.
 ├
 		[V] ospf:RsIfDefToOspfv3If A source relation to the OSPF v3 interfaces


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] pol:Obj Represents a generic policy object.
 
 		 ├
 		[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 		 
 		 ├
 		[V] fabric:ProtoComp A base class for protocol policies.
 
 		 
 		 
 		 ├
 		[V] fabric:L3ProtoComp A base class for layer 3 protocol policies.
 
 		 
 		 
 		 
 		 ├
 		[V] ospf:AIfP An abstraction of the OSPF interface profile information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ospf:IfDef The OSPF interface definition model.


Events


Faults


Fsms


Properties Summary
Defined in: ospf:IfDef
ospf:IfCost
          scalar:Uint16 		cost  (ospf:IfDef:cost)
           The definition cost on the OSPF interface.
ospf:IfControl
          scalar:Bitmask8 		ctrl  (ospf:IfDef:ctrl)
           The definition controls on the OSPF interface.
ospf:DeadIntvl
          scalar:Uint16 		deadIntvl  (ospf:IfDef: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.
ospf:HelloIntvl
          scalar:Uint16 		helloIntvl  (ospf:IfDef:helloIntvl)
           The interval between hello packets that OSPF sends on the interface. Note that the smaller the hello interval, the faster topological changes will be detected, but more routing traffic will ensue. This value must be the same for all routers and access servers on a specific network.
ospf:NwT
          scalar:Enum8 		nwT  (ospf:IfDef:nwT)
           The OSPF interface policy network type. OSPF supports point-to-point and broadcast.
ospf:IfPfxSuppress
          scalar:Enum8 		pfxSuppress  (ospf:IfDef:pfxSuppress)
           prefix suppression
ospf:DesigPrio
          scalar:UByte 		prio  (ospf:IfDef:prio)
           The OSPF interface priority used to determine the designated router (DR) on a specific network. The router with the highest OSPF priority on a segment will become the DR for that segment. The same process is repeated for the backup designated router (BDR). In the case of a tie, the router with the highest RID will win. The default for the interface OSPF priority is one. Remember that the DR and BDR concepts are per multiaccess segment.
ospf:RexmitIntvl
          scalar:Uint16 		rexmitIntvl  (ospf:IfDef: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:XmitDelay
          scalar:Uint16 		xmitDelay  (ospf:IfDef: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: ospf:AIfP
ospf:AuthKey
          string:Password 		authKey  (ospf:AIfP:authKey)
           The OSPF authentication key
ospf:AuthKeyId
          scalar:UByte 		authKeyId  (ospf:AIfP:authKeyId)
          
ospf:AuthT
          scalar:Enum8 		authType  (ospf:AIfP:authType)
           The OSPF authentication type. The type options are; default, md5, none, and simple.
Defined in: pol:Comp
naming:Descr
          string:Basic 		descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic 		name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

authKey

Type: ospf:AuthKey
Primitive Type: string:Password

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
    Comments:
The OSPF authentication key


authKeyId

Type: ospf:AuthKeyId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Constants
defaultValue 1 --- NO COMMENTS




authType

Type: ospf:AuthT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The OSPF authentication type. The type options are; default, md5, none, and simple.
Constants
none 0 No authentication None
simple 1 Simple authentication Simple
md5 2 MD5 authentication MD5
DEFAULT none(0) No authentication None




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

Like: ospf:AIf:cost
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The definition cost on the OSPF interface.
Constants
unspecified 0 Unspecified NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS




ctrl

Type: ospf:IfControl
Primitive Type: scalar:Bitmask8

Like: ospf:AIf:ctrl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The definition controls on the OSPF interface.
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

Like: ospf:AIf:deadIntvl
Units: sec
Encrypted: false
Access: admin
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:
Specifies the description of a policy component.


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.


helloIntvl

Type: ospf:HelloIntvl
Primitive Type: scalar:Uint16

Like: ospf:AIf:helloIntvl
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The interval between hello packets that OSPF sends on the interface. Note that the smaller the hello interval, the faster topological changes will be detected, but more routing traffic will ensue. This value must be the same for all routers and access servers on a specific network.
Constants
defaultValue 10 --- 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:naming:NamedObject:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
null


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS


nwT

Type: ospf:NwT
Primitive Type: scalar:Enum8

Like: ospf:AIf:nwT
Units: null
Encrypted: false
Access: admin
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




pfxSuppress

Type: ospf:IfPfxSuppress
Primitive Type: scalar:Enum8

Like: ospf:AIf:pfxSuppress
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
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

Like: ospf:AIf:prio
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The OSPF interface priority used to determine the designated router (DR) on a specific network. The router with the highest OSPF priority on a segment will become the DR for that segment. The same process is repeated for the backup designated router (BDR). In the case of a tie, the router with the highest RID will win. The default for the interface OSPF priority is one. Remember that the DR and BDR concepts are per multiaccess segment.
Constants
defaultValue 1 --- NO COMMENTS




rexmitIntvl

Type: ospf:RexmitIntvl
Primitive Type: scalar:Uint16

Like: ospf:AIf:rexmitIntvl
Units: sec
Encrypted: false
Access: admin
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.





xmitDelay

Type: ospf:XmitDelay
Primitive Type: scalar:Uint16

Like: ospf:AIf:xmitDelay
Units: sec
Encrypted: false
Access: admin
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  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail