Class ospf:CtxPol (CONCRETE)

Class ID:1416
Class Label: OSPF Timers Policy
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin, tenant-ext-protocol-l3]
Read Access: [admin, tenant-connectivity-l3, tenant-ext-protocol-l3]
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 context-level OSPF timer policy provides the Hello timer and Dead timer intervals configuration.

Naming Rules
RN FORMAT: ospfCtxP-{name}

    [1] PREFIX=ospfCtxP- PROPERTY = name




DN FORMAT: 

[1] uni/tn-{name}/ospfCtxP-{name}

                


Diagram

Super Mo: ospf:ACtxPol,
Container Mos: fv:Tenant (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations From: fv:Ctx, fv:RtdEpP,
Relations: ospf:RtCtxToOspfCtxPol, ospf:RtEppOspfAfCtxPol, ospf:RtEppOspfCtxPol, ospf:RtOspfCtxPol,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] ospf:CtxPol The context-level OSPF timer policy provides the Hello timer and Dead timer intervals configuration.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] ospf:CtxPol The context-level OSPF timer policy provides the Hello timer and Dead timer intervals configuration.


Contained Hierarchy
[V] ospf:CtxPol The context-level OSPF timer policy provides the Hello timer and Dead timer intervals configuration.
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 ├
[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:RtCtxToOspfCtxPol A target relation to the per-address family OSPF context policy.
 ├
[V] ospf:RtEppOspfAfCtxPol A source relation to per address family OSPF context policy.
 ├
[V] ospf:RtEppOspfCtxPol A target relation to the context-level OSPF timer policy.
 ├
[V] ospf:RtOspfCtxPol A target relation to the context-level OSPF timer policy.
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


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:Def Represents self-contained policy document.
 
 
 ├
[V] fabric:ProtoPol A base class for protocol policies.
 
 
 
 ├
[V] fabric:ProtoDomPol A base class for context-level protocol policies.
 
 
 
 
 ├
[V] fabric:L3DomPol A base class for layer 3 context-level policies.
 
 
 
 
 
 ├
[V] fabric:L3CtxPol A base class for layer 3 context-level policies.
 
 
 
 
 
 
 ├
[V] ospf:ACtxPol The OSPF policy information.
 
 
 
 
 
 
 
 ├
[V] ospf:CtxPol The context-level OSPF timer policy provides the Hello timer and Dead timer intervals configuration.


Events
                ospf:CtxPol:creation__ospf_CtxPol
ospf:CtxPol:modification__ospf_CtxPol
ospf:CtxPol:deletion__ospf_CtxPol


Faults
                


Fsms
                


Properties Summary
Defined in: ospf:CtxPol
mo:Annotation
          string:Basic
annotation  (ospf:CtxPol:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (ospf:CtxPol:extMngdBy)
           NO COMMENTS
naming:Name
          string:Basic
name  (ospf:CtxPol:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The context-level OSPF policy name. This name can be between 1 and 64 alphanumeric characters. Note that you cannot change this name after the object has been saved.
Defined in: ospf:ACtxPol
ospf:BwRef
          scalar:Uint32
bwRef  (ospf:ACtxPol:bwRef)
           The OSPF policy bandwidth reference. This is used to calculate the default metrics for an interface.
ospf:DomControl
          scalar:Bitmask8
ctrl  (ospf:ACtxPol:ctrl)
           The control state.
ospf:Dist
          scalar:UByte
dist  (ospf:ACtxPol:dist)
           The preferred administrative distance.
ospf:GRControls
          scalar:Bitmask8
grCtrl  (ospf:ACtxPol:grCtrl)
           The graceful restart controls.
ospf:LsaArrivalIntvl
          scalar:Uint32
lsaArrivalIntvl  (ospf:ACtxPol:lsaArrivalIntvl)
           The minimum interval between the arrival of each link-state advertisement (LSA).
ospf:LsaGpPacingIntvl
          scalar:Uint16
lsaGpPacingIntvl  (ospf:ACtxPol:lsaGpPacingIntvl)
           The interval in which LSAs are grouped and refreshed, checksummed, or aged. The duration of the LSA group pacing is inversely proportional to the number of LSAs that the router is handling. For example, if you have about 10,000 LSAs, you should decrease the pacing interval. If you have a very small database (40 to 100 LSAs), you should increase the pacing interval to 10 to 20 minutes.
ospf:LsaThHoldIntvl
          scalar:Uint32
lsaHoldIntvl  (ospf:ACtxPol:lsaHoldIntvl)
           The incremental time (in milliseconds) used to calculate the subsequent rate limiting times for LSA generation.
ospf:LsaThMaxIntvl
          scalar:Uint32
lsaMaxIntvl  (ospf:ACtxPol:lsaMaxIntvl)
           The generation throttle maximum interval between LSAs.
ospf:LsaThStartIntvl
          scalar:Uint32
lsaStartIntvl  (ospf:ACtxPol:lsaStartIntvl)
           The generation throttle start-wait interval between LSAs.
ospf:Ecmp
          scalar:UByte
maxEcmp  (ospf:ACtxPol:maxEcmp)
           The maximum ECMP for the OSPF protocol.
ospf:MaxLsaAct
          scalar:Enum8
maxLsaAction  (ospf:ACtxPol:maxLsaAction)
           The action to take when the maximum LSA limit is reached.
ospf:MaxLsa
          scalar:Uint32
maxLsaNum  (ospf:ACtxPol:maxLsaNum)
           The maximum number of LSAs that are not self-generated.
ospf:ResetIntvl
          scalar:Uint32
maxLsaResetIntvl  (ospf:ACtxPol:maxLsaResetIntvl)
           The time (in minutes) before the sleep count is reset to zero.
ospf:SleepCnt
          scalar:Uint32
maxLsaSleepCnt  (ospf:ACtxPol:maxLsaSleepCnt)
           The number of times the OSPF process can consecutively be placed into the sleep state.
ospf:SleepIntvl
          scalar:Uint16
maxLsaSleepIntvl  (ospf:ACtxPol:maxLsaSleepIntvl)
           The time (in minutes) to ignore all neighbors after the maximum limit of LSAs has been exceeded.
ospf:MaxLsaThresh
          scalar:Uint16
maxLsaThresh  (ospf:ACtxPol:maxLsaThresh)
           The maximum link-state advertisement (LSA) threshold value (%) at which to generate a warning message.
ospf:SpfCompHoldIntvl
          scalar:Uint32
spfHoldIntvl  (ospf:ACtxPol:spfHoldIntvl)
           The minimum hold time between SPF calculations.
ospf:SpfCompInitIntvl
          scalar:Uint32
spfInitIntvl  (ospf:ACtxPol:spfInitIntvl)
           The initial delay interval for the SPF schedule.
ospf:SpfCompMaxIntvl
          scalar:Uint32
spfMaxIntvl  (ospf:ACtxPol:spfMaxIntvl)
           The maximum interval between SPF calculations. Each interval after the initial calculation is twice as long as the previous one until the wait interval reaches the maximum wait time specified.
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



bwRef

Type: ospf:BwRef
Primitive Type: scalar:Uint32

Like: ospf:ADom:bwRef
Units: Mbps
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4000000l
    Comments:
The OSPF policy bandwidth reference. This is used to calculate the default metrics for an interface.
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

Like: ospf:ADom:ctrl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



dist

Type: ospf:Dist
Primitive Type: scalar:UByte

Like: ospf:ADom:dist
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)1  max: (short)255
    Comments:
The preferred 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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





grCtrl

Type: ospf:GRControls
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The graceful restart controls.
Constants
helper 1 Graceful Restart Helper Helper mode enabled
DEFAULT helper(1) Graceful Restart Helper Helper mode enabled





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





lsaArrivalIntvl

Type: ospf:LsaArrivalIntvl
Primitive Type: scalar:Uint32

Units: ms
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)10l  max: (long)600000l
    Comments:
The minimum interval between the arrival of each link-state advertisement (LSA).
Constants
defaultValue 1000u --- NO COMMENTS





lsaGpPacingIntvl

Type: ospf:LsaGpPacingIntvl
Primitive Type: scalar:Uint16

Units: secs
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 1800
    Comments:
The interval in which LSAs are grouped and refreshed, checksummed, or aged. The duration of the LSA group pacing is inversely proportional to the number of LSAs that the router is handling. For example, if you have about 10,000 LSAs, you should decrease the pacing interval. If you have a very small database (40 to 100 LSAs), you should increase the pacing interval to 10 to 20 minutes.
Constants
defaultValue 10 --- NO COMMENTS





lsaHoldIntvl

Type: ospf:LsaThHoldIntvl
Primitive Type: scalar:Uint32

Units: ms
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)50l  max: (long)30000l
    Comments:
The incremental time (in milliseconds) used to calculate the subsequent rate limiting times for LSA generation.
Constants
defaultValue 5000u --- NO COMMENTS





lsaMaxIntvl

Type: ospf:LsaThMaxIntvl
Primitive Type: scalar:Uint32

Units: ms
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)50l  max: (long)30000l
    Comments:
The generation throttle maximum interval between LSAs.
Constants
defaultValue 5000u --- NO COMMENTS





lsaStartIntvl

Type: ospf:LsaThStartIntvl
Primitive Type: scalar:Uint32

Units: ms
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)5000l
    Comments:
The generation throttle start-wait interval between LSAs.
Constants
defaultValue 0u --- NO COMMENTS





maxEcmp

Type: ospf:Ecmp
Primitive Type: scalar:UByte

Like: ospf:ADom:maxEcmp
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)1  max: (short)64
    Comments:
The maximum ECMP for the OSPF protocol.
Constants
defaultValue 8 --- NO COMMENTS





maxLsaAction

Type: ospf:MaxLsaAct
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The action to take when the maximum LSA limit is reached.
Constants
reject 0 Reject Reject LSAs beyond the limit
restart 1 Restart Restart the neighbor
log 2 Log log a warning
DEFAULT reject(0) Reject Reject LSAs beyond the limit





maxLsaNum

Type: ospf:MaxLsa
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4294967295l
    Comments:
The maximum number of LSAs that are not self-generated.
Constants
defaultValue 20000u --- NO COMMENTS





maxLsaResetIntvl

Type: ospf:ResetIntvl
Primitive Type: scalar:Uint32

Units: min
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)1440l
    Comments:
The time (in minutes) before the sleep count is reset to zero.
Constants
defaultValue 10u --- NO COMMENTS





maxLsaSleepCnt

Type: ospf:SleepCnt
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4294967295l
    Comments:
The number of times the OSPF process can consecutively be placed into the sleep state.
Constants
defaultValue 5u --- NO COMMENTS





maxLsaSleepIntvl

Type: ospf:SleepIntvl
Primitive Type: scalar:Uint16

Units: min
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 1440
    Comments:
The time (in minutes) to ignore all neighbors after the maximum limit of LSAs has been exceeded.
Constants
defaultValue 5 --- NO COMMENTS





maxLsaThresh

Type: ospf:MaxLsaThresh
Primitive Type: scalar:Uint16

Units: percentage
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 100
    Comments:
The maximum link-state advertisement (LSA) threshold value (%) at which to generate a warning message.
Constants
defaultValue 75 --- 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:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The context-level OSPF policy name. This name can be between 1 and 64 alphanumeric characters. Note that you cannot change this name after the object has been saved.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this 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.



spfHoldIntvl

Type: ospf:SpfCompHoldIntvl
Primitive Type: scalar:Uint32

Units: ms
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)600000l
    Comments:
The minimum hold time between SPF calculations.
Constants
defaultValue 1000u --- NO COMMENTS





spfInitIntvl

Type: ospf:SpfCompInitIntvl
Primitive Type: scalar:Uint32

Units: ms
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)600000l
    Comments:
The initial delay interval for the SPF schedule.
Constants
defaultValue 200u --- NO COMMENTS





spfMaxIntvl

Type: ospf:SpfCompMaxIntvl
Primitive Type: scalar:Uint32

Units: ms
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)600000l
    Comments:
The maximum interval between SPF calculations. Each interval after the initial calculation is twice as long as the previous one until the wait interval reaches the maximum wait time specified.
Constants
defaultValue 5000u --- 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.






uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.