Class aib:If (CONCRETE)

Class ID:15594
Class Label: Interface
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l3, access-protocol-l3, admin, fabric-connectivity-l3, fabric-protocol-l3, tenant-connectivity-l3, tenant-ext-connectivity-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: true, HasFaults: true, HasHealth: true, HasEventRules: false ]

NO COMMENTS

Naming Rules
RN FORMAT: if-{[if]}

    [1] PREFIX=if- PROPERTY = if




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/aib/dom-{name}/db-{type}/if-{[if]}

[1] sys/aib/dom-{name}/db-{type}/if-{[if]}

                


Diagram

Container Mos: aib:Db (deletable:yes),
Contained Mos: aib:IfAdj,


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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] aib:Entity This is a top-level placeholder for the Adjacency Information Base (AIB) attributes, if any.
 
 
 
 
 
 ├
[V] aib:Dom The Virtual Routing and Forwarding (VRF).
 
 
 
 
 
 
 ├
[V] aib:Db A placeholder for all the IP adjacencies.
 
 
 
 
 
 
 
 ├
[V] aib:If 
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] aib:Entity This is a top-level placeholder for the Adjacency Information Base (AIB) attributes, if any.
 
 
 ├
[V] aib:Dom The Virtual Routing and Forwarding (VRF).
 
 
 
 ├
[V] aib:Db A placeholder for all the IP adjacencies.
 
 
 
 
 ├
[V] aib:If 


Contained Hierarchy
[V] aib:If 
 ├
[V] aib:IfAdj  Adjacency database record
 
 ├
[V] aib:IfAdjOwner  Aadjacency ownership record
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 ├
[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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] aib:If 


Stat Counters
scalar:Uint64 COUNTER: aib:IfAdjCounts:ifadjupdates(count)
           adjacency updates counts per interface
          Comments: Adjacency Updates counts


Stats
[V] aib:If 
 ├
[V] aib:IfAdjCounts15min Adjacency counters. A class that represents the most current statistics for Interface Adjacency Counts in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] aib:IfAdjCounts1d Adjacency counters. A class that represents the most current statistics for Interface Adjacency Counts in a 1 day sampling interval. This class updates every hour.
 ├
[V] aib:IfAdjCounts1h Adjacency counters. A class that represents the most current statistics for Interface Adjacency Counts in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] aib:IfAdjCounts1mo Adjacency counters. A class that represents the most current statistics for Interface Adjacency Counts in a 1 month sampling interval. This class updates every day.
 ├
[V] aib:IfAdjCounts1qtr Adjacency counters. A class that represents the most current statistics for Interface Adjacency Counts in a 1 quarter sampling interval. This class updates every day.
 ├
[V] aib:IfAdjCounts1w Adjacency counters. A class that represents the most current statistics for Interface Adjacency Counts in a 1 week sampling interval. This class updates every day.
 ├
[V] aib:IfAdjCounts1year Adjacency counters. A class that represents the most current statistics for Interface Adjacency Counts in a 1 year sampling interval. This class updates every day.
 ├
[V] aib:IfAdjCounts5min Adjacency counters. A class that represents the most current statistics for Interface Adjacency Counts in a 5 minute sampling interval. This class updates every 10 seconds.
 ├
[V] aib:IfAdjCountsHist15min Adjacency counters. A class that represents historical statistics for Interface Adjacency Counts in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] aib:IfAdjCountsHist1d Adjacency counters. A class that represents historical statistics for Interface Adjacency Counts in a 1 day sampling interval. This class updates every hour.
 ├
[V] aib:IfAdjCountsHist1h Adjacency counters. A class that represents historical statistics for Interface Adjacency Counts in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] aib:IfAdjCountsHist1mo Adjacency counters. A class that represents historical statistics for Interface Adjacency Counts in a 1 month sampling interval. This class updates every day.
 ├
[V] aib:IfAdjCountsHist1qtr Adjacency counters. A class that represents historical statistics for Interface Adjacency Counts in a 1 quarter sampling interval. This class updates every day.
 ├
[V] aib:IfAdjCountsHist1w Adjacency counters. A class that represents historical statistics for Interface Adjacency Counts in a 1 week sampling interval. This class updates every day.
 ├
[V] aib:IfAdjCountsHist1year Adjacency counters. A class that represents historical statistics for Interface Adjacency Counts in a 1 year sampling interval. This class updates every day.
 ├
[V] aib:IfAdjCountsHist5min Adjacency counters. A class that represents historical statistics for Interface Adjacency Counts in a 5 minute sampling interval. This class updates every 10 seconds.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: aib:If
nw:IfId
          base:IfIndex
if  (aib:If:if)
           The OSPF Multicast nexthop interface.
scalar:Uint64 ifAdjUpSeqNum  (aib:If:ifAdjUpSeqNum)
           Adjacency Update Sequence Number
reference:BinRef monPolDn  (aib:If:monPolDn)
           The monitoring policy attached to this observable object.
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

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





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.



if

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The OSPF Multicast nexthop interface.



ifAdjUpSeqNum

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Adjacency Update Sequence Number



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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable 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.