Class isis:If (CONCRETE)

Class ID:2834
Class Label: IS-IS Interface
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: 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: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The ISIS interface holds ISIS information that is operated at an interface level.

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

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/isis/inst-{name}/dom-{name}/if-{[id]}

[1] sys/isis/inst-{name}/dom-{name}/if-{[id]}

                


Diagram

Super Mo: l3:ProtIf,
Container Mos: isis:Dom (deletable:no),
Contained Mos: isis:AdjEp, isis:IfLvl, isis:IfTraffic, isis:MeshGrp,
Relations From: nw:PathEp,
Relations: nw:RtPathToIf,


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] isis:Entity IS-IS control plane entity information.
 
 
 
 
 
 ├
[V] isis:Inst Per- IS-IS instance information.
 
 
 
 
 
 
 ├
[V] isis:Dom The IS-IS domain (vrf) information.
 
 
 
 
 
 
 
 ├
[V] isis:If The ISIS interface holds ISIS information that is operated at an interface level.
[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] isis:Entity IS-IS control plane entity information.
 
 
 ├
[V] isis:Inst Per- IS-IS instance information.
 
 
 
 ├
[V] isis:Dom The IS-IS domain (vrf) information.
 
 
 
 
 ├
[V] isis:If The ISIS interface holds ISIS information that is operated at an interface level.


Contained Hierarchy
[V] isis:If The ISIS interface holds ISIS information that is operated at an interface level.
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] isis:AdjEp The ISIS adjacency neighbor endpoint is a managed object that captures ISIS adjacency specific information such as peer system identifier and peer circuit identifier.
 
 ├
[V] isis:PeerIpAddr The peer IP address is the IP address of the other end of the tunnel. From the client PC, the peer IP address would be the IP address of the router.
 ├
[V] isis:IfLvl The IS-IS interface level properties. These properties control how the IS-IS protocol operates. For example, you can configure the interval for sending the Hello and CSNP packets.
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] isis:IfTraffic Per-interface state information.
 ├
[V] isis:MeshGrp The mesh group information per interface.
 
 ├
[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] nw:RtPathToIf A target relation to the interface information.


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] isis:If The ISIS interface holds ISIS information that is operated at an interface level.


Events
                


Faults
                isis:If:InitError


Fsms
                


Properties Summary
Defined in: isis:If
isis:IsT
          scalar:Enum8
cktT  (isis:If:cktT)
           The IS-IS interface circuit type.
isis:IfControl
          scalar:Bitmask8
ctrl  (isis:If:ctrl)
           The IS-IS interface controls.
scalar:Uint32 extdLocalCktId  (isis:If:extdLocalCktId)
          
nw:IfId
          base:IfIndex
id  (isis:If:id)
           Overrides:nw:If:id
           Specifies the IS-IS interface ID.
scalar:Uint16 iibIdx  (isis:If:iibIdx)
           Specifies the IS-IS interface IIB Index.
string:Basic iibState  (isis:If:iibState)
           The internal IS-IS protocol state
scalar:Bool iibUpCtrl  (isis:If:iibUpCtrl)
          
scalar:Bool initError  (isis:If:initError)
           The following attributes should go away once IFC can provide a way to decode a bitmask
scalar:Uint16 localCktId  (isis:If:localCktId)
          
isis:LspRefreshIntvl
          scalar:Uint32
lspRefreshIntvl  (isis:If:lspRefreshIntvl)
           The IS-IS interface LSP refresh interval. By default, the router sends a periodic LSP refresh. LSPs remain in a database for 20 minutes by default. If they are not refreshed by that time, they are deleted. You can change the LSP refresh interval or the LSP lifetime. The LSP interval should be less than the LSP lifetime or else LSPs will time out before they are refreshed. The software will adjust the LSP refresh interval if necessary to prevent the LSPs from timing out
isis:Metric
          scalar:Uint32
metric  (isis:If:metric)
           The IS-IS metric value.
reference:BinRef monPolDn  (isis:If:monPolDn)
           The monitoring policy for the IS-IS interface object.
scalar:Date nextIIHTs  (isis:If:nextIIHTs)
          
string:Basic p2pCktId  (isis:If:p2pCktId)
          
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)
          
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
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: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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

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





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





cktT

Type: isis:IsT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IS-IS interface circuit type.
Constants
l1 1 L1 IS type L1 IS type
l2 2 L2 IS type L2 IS type
l12 3 L1-2 IS type L1-2 IS type
DEFAULT l1(1) L1 IS type L1 IS type





ctrl

Type: isis:IfControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IS-IS interface controls.
Constants
advert-tep 1 Advertise TEP TLV Advertise TEP
passive 2 Passive Participation Passive
hello-padding 4 Hello Padding Hello padding
exchange-hostname 8 Exchange Hostname Exchange host name
attached 16 Attached Attached
supress-prefix-advert 32 Suppress Prefix Advertisement Suppressive prefix advertisement
DEFAULT 0 --- Interface controls





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.



extdLocalCktId

Type: scalar:Uint32

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



id

Type: nw:IfId
Primitive Type: base:IfIndex

Overrides:nw:If:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
Specifies the IS-IS interface ID.



iibIdx

Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the IS-IS interface IIB Index.



iibState

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The internal IS-IS protocol state



iibUpCtrl

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





initError

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The following attributes should go away once IFC can provide a way to decode a bitmask
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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





localCktId

Type: scalar:Uint16

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



lspRefreshIntvl

Type: isis:LspRefreshIntvl
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IS-IS interface LSP refresh interval. By default, the router sends a periodic LSP refresh. LSPs remain in a database for 20 minutes by default. If they are not refreshed by that time, they are deleted. You can change the LSP refresh interval or the LSP lifetime. The LSP interval should be less than the LSP lifetime or else LSPs will time out before they are refreshed. The software will adjust the LSP refresh interval if necessary to prevent the LSPs from timing out
Constants
defaultValue 33u --- NO COMMENTS





metric

Type: isis:Metric
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IS-IS metric value.
Constants
defaultValue 1u --- 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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy for the IS-IS interface object.



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.



nextIIHTs

Type: scalar:Date

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



p2pCktId

Type: string:Basic

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