Class cloud:OspfIfPDef (CONCRETE)

Class ID:14447
Class Label: OSPF Interface PolicyDef
Encrypted: false - 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, tenant-connectivity, tenant-ext-connectivity]
Creatable/Deletable: yes (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 ]

NO COMMENTS

Naming Rules
RN FORMAT: ospfifpd-{[area]}-af-{af}

    [1] PREFIX=ospfifpd- PROPERTY = area


    [2] PREFIX=-af- PROPERTY = af




DN FORMAT: 

[0] ctxdefcont/gatewayrouterpd-{[gatewayRouterPDn]}/extnetworkpd-{name}/hostifpd-{nicId}/l3tunnelifpd-{name}/l3ifpd/ospfifpd-{[area]}-af-{af}

[1] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/extnetworkpd-{name}/hostifpd-{nicId}/l3tunnelifpd-{name}/l3ifpd/ospfifpd-{[area]}-af-{af}

[2] ctxdefcont/gatewayrouterpd-{[gatewayRouterPDn]}/intnetworkpd-{name}/hostifpd-{nicId}/l3tunnelifpd-{name}/l3ifpd/ospfifpd-{[area]}-af-{af}

[3] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/intnetworkpd-{name}/hostifpd-{nicId}/l3tunnelifpd-{name}/l3ifpd/ospfifpd-{[area]}-af-{af}

[4] ctxdefcont/gatewayrouterpd-{[gatewayRouterPDn]}/extnetworkpd-{name}/lbifpd-{name}/l3ifpd/ospfifpd-{[area]}-af-{af}

[5] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/extnetworkpd-{name}/lbifpd-{name}/l3ifpd/ospfifpd-{[area]}-af-{af}

[6] ctxdefcont/gatewayrouterpd-{[gatewayRouterPDn]}/extnetworkpd-{name}/hostifpd-{nicId}/l3ifpd/ospfifpd-{[area]}-af-{af}

[7] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/extnetworkpd-{name}/hostifpd-{nicId}/l3ifpd/ospfifpd-{[area]}-af-{af}

[8] ctxdefcont/gatewayrouterpd-{[gatewayRouterPDn]}/intnetworkpd-{name}/hostifpd-{nicId}/l3ifpd/ospfifpd-{[area]}-af-{af}

[9] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/intnetworkpd-{name}/hostifpd-{nicId}/l3ifpd/ospfifpd-{[area]}-af-{af}

                


Diagram

Super Mo: cloud:AOspfIfP,
Container Mos: cloud:L3IfPDef (deletable:yes),


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] cloud:CtxDefCont 
 
 ├
[V] cloud:GatewayRouterPDef 
 
 
 ├
[V] cloud:ExtNetworkPDef 
 
 
 
 ├
[V] cloud:HostIfPDef 
 
 
 
 
 ├
[V] cloud:L3TunnelIfPDef 
 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:CtxProfileDef 
 
 
 ├
[V] cloud:RegionLocale 
 
 
 
 ├
[V] cloud:RouterPDef 
 
 
 
 
 ├
[V] cloud:ExtNetworkPDef 
 
 
 
 
 
 ├
[V] cloud:HostIfPDef 
 
 
 
 
 
 
 ├
[V] cloud:L3TunnelIfPDef 
 
 
 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:GatewayRouterPDef 
 
 
 ├
[V] cloud:IntNetworkPDef 
 
 
 
 ├
[V] cloud:HostIfPDef 
 
 
 
 
 ├
[V] cloud:L3TunnelIfPDef 
 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:CtxProfileDef 
 
 
 ├
[V] cloud:RegionLocale 
 
 
 
 ├
[V] cloud:RouterPDef 
 
 
 
 
 ├
[V] cloud:IntNetworkPDef 
 
 
 
 
 
 ├
[V] cloud:HostIfPDef 
 
 
 
 
 
 
 ├
[V] cloud:L3TunnelIfPDef 
 
 
 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:GatewayRouterPDef 
 
 
 ├
[V] cloud:ExtNetworkPDef 
 
 
 
 ├
[V] cloud:LoopbackIfPDef 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:CtxProfileDef 
 
 
 ├
[V] cloud:RegionLocale 
 
 
 
 ├
[V] cloud:RouterPDef 
 
 
 
 
 ├
[V] cloud:ExtNetworkPDef 
 
 
 
 
 
 ├
[V] cloud:LoopbackIfPDef 
 
 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:GatewayRouterPDef 
 
 
 ├
[V] cloud:ExtNetworkPDef 
 
 
 
 ├
[V] cloud:HostIfPDef 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:CtxProfileDef 
 
 
 ├
[V] cloud:RegionLocale 
 
 
 
 ├
[V] cloud:RouterPDef 
 
 
 
 
 ├
[V] cloud:ExtNetworkPDef 
 
 
 
 
 
 ├
[V] cloud:HostIfPDef 
 
 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:GatewayRouterPDef 
 
 
 ├
[V] cloud:IntNetworkPDef 
 
 
 
 ├
[V] cloud:HostIfPDef 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 
[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] cloud:CtxDefCont 
 
 ├
[V] cloud:CtxProfileDef 
 
 
 ├
[V] cloud:RegionLocale 
 
 
 
 ├
[V] cloud:RouterPDef 
 
 
 
 
 ├
[V] cloud:IntNetworkPDef 
 
 
 
 
 
 ├
[V] cloud:HostIfPDef 
 
 
 
 
 
 
 ├
[V] cloud:L3IfPDef 
 
 
 
 
 
 
 
 ├
[V] cloud:OspfIfPDef 


Contained Hierarchy
[V] cloud:OspfIfPDef 
 ├
[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.


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] cloud:AOspfIfP  Underlay OSPF configuration.
 
 
 
 ├
[V] cloud:OspfIfPDef 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: cloud:OspfIfPDef
ospf:AfType
          scalar:Bitmask8
af  (cloud:OspfIfPDef:af)
           Overrides:cloud:AOspfIfP:af
           NO COMMENTS
address:Ip area  (cloud:OspfIfPDef:area)
           Overrides:cloud:AOspfIfP: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.
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: 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: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: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.
Properties Detail

af

Type: ospf:AfType
Primitive Type: scalar:Bitmask8

Overrides:cloud:AOspfIfP:af
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
ipv4-ucast 1 IPv4 unicast address family ipv4 unicast
ipv6-ucast 2 IPv6 unicast address family ipv6 unicast
defaultValue 0 --- Default is v4





area

Type: address:Ip

Overrides:cloud:AOspfIfP:area
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming 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.



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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a description of the policy definition.



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.



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



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

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



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.