Class isis:Entity (CONCRETE)

Class ID:2855
Class Label: IS-IS Entity
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: false, HasHealth: true, HasEventRules: false ]

IS-IS control plane entity information.

Naming Rules
RN FORMAT: isis

    [1] PREFIX=isis


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/isis

[1] sys/isis

                


Diagram

Super Mo: l3:ProtEntity,
Container Mos: top:System (deletable:no),
Contained Mos: isis:Inst,


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] 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.


Contained Hierarchy
[V] isis:Entity IS-IS control plane entity information.
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] isis:Inst Per- IS-IS instance information.
 
 ├
[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:Dom The IS-IS domain (vrf) information.
 
 
 ├
[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:Db The IS-IS database information.
 
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 
 ├
[V] isis:DTEp The discovered IP security (IPsec) endpoints. The deployment of IPsec with Internet Key Exchange (IKE) requires the configuration of a crypto map for every peer which identifies the endpoint to which a secure tunnel is to be established.
 
 
 
 ├
[V] isis:GrpRec The database of fabric multicast group elements.
 
 
 
 
 ├
[V] isis:BdIdRec The IS-IS multicast address family feature provides support for multiple logical topologies over a single physical network. This object contains bridge domain records active for this multicast group element.
 
 
 
 
 ├
[V] isis:FtagOifRec Per-forwarding tag (FTAG) OIF list record.
 
 
 
 
 
 ├
[V] isis:OifListLeaf The outgoing interface list on the leaf switch.
 
 
 
 
 
 ├
[V] isis:OifListSpine The outgoing interface list on the spine switch.
 
 
 
 
 ├
[V] isis:NodeIdRec The fabric nodes active for this multicast group element.
 
 
 
 
 ├
[V] isis:OifListLeaf The outgoing interface list on the leaf switch.
 
 
 
 
 ├
[V] isis:OifListSpine The outgoing interface list on the spine switch.
 
 
 
 ├
[V] isis:LspRec The link state packet information records lists the device's neighbors and prefix reachability information.
 
 
 
 
 ├
[V] isis:ExtIsRec The extended IS record.
 
 
 
 
 ├
[V] isis:IpRec The IP Prefix record.
 
 
 
 
 ├
[V] isis:TlvRec The generic Type Length Value (TLV) record.
 
 
 
 ├
[V] isis:Nexthop The IS-IS next hop.
 
 
 
 
 ├
[V] isis:RtNhAtt A target relation to the IS-IS next hop.
 
 
 
 ├
[V] isis:NodeRec The node records.
 
 
 
 
 ├
[V] isis:GrpIdRec The multicast groups identifier record.
 
 
 
 ├
[V] isis:Route An ISIS route is a managed object that captures the routing information learned through ISIS protocol.
 
 
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 
 
 ├
[V] isis:RsNhAtt A source relation to the list of next hopss
 
 
 
 
 
 ├
[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:DefRtLeakP The default route leak policy.
 
 
 
 ├
[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] isis:DomAf Per address family IS-IS VRF information.
 
 
 ├
[V] isis:DomLvl The IS-IS Domain level VRF information.
 
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 
 ├
[V] isis:Db The IS-IS database information.
 
 
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 
 
 ├
[V] isis:DTEp The discovered IP security (IPsec) endpoints. The deployment of IPsec with Internet Key Exchange (IKE) requires the configuration of a crypto map for every peer which identifies the endpoint to which a secure tunnel is to be established.
 
 
 
 
 ├
[V] isis:GrpRec The database of fabric multicast group elements.
 
 
 
 
 
 ├
[V] isis:BdIdRec The IS-IS multicast address family feature provides support for multiple logical topologies over a single physical network. This object contains bridge domain records active for this multicast group element.
 
 
 
 
 
 ├
[V] isis:FtagOifRec Per-forwarding tag (FTAG) OIF list record.
 
 
 
 
 
 
 ├
[V] isis:OifListLeaf The outgoing interface list on the leaf switch.
 
 
 
 
 
 
 ├
[V] isis:OifListSpine The outgoing interface list on the spine switch.
 
 
 
 
 
 ├
[V] isis:NodeIdRec The fabric nodes active for this multicast group element.
 
 
 
 
 
 ├
[V] isis:OifListLeaf The outgoing interface list on the leaf switch.
 
 
 
 
 
 ├
[V] isis:OifListSpine The outgoing interface list on the spine switch.
 
 
 
 
 ├
[V] isis:LspRec The link state packet information records lists the device's neighbors and prefix reachability information.
 
 
 
 
 
 ├
[V] isis:ExtIsRec The extended IS record.
 
 
 
 
 
 ├
[V] isis:IpRec The IP Prefix record.
 
 
 
 
 
 ├
[V] isis:TlvRec The generic Type Length Value (TLV) record.
 
 
 
 
 ├
[V] isis:Nexthop The IS-IS next hop.
 
 
 
 
 
 ├
[V] isis:RtNhAtt A target relation to the IS-IS next hop.
 
 
 
 
 ├
[V] isis:NodeRec The node records.
 
 
 
 
 
 ├
[V] isis:GrpIdRec The multicast groups identifier record.
 
 
 
 
 ├
[V] isis:Route An ISIS route is a managed object that captures the routing information learned through ISIS protocol.
 
 
 
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 
 
 
 ├
[V] isis:RsNhAtt A source relation to the list of next hopss
 
 
 
 
 
 
 ├
[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:LspGen The LSP generation interval controls.
 
 
 
 ├
[V] isis:RtSum This object holds summarization address. Any address that maps to this prefix will be summarized through this address
 
 
 
 
 ├
[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] isis:SpfComp The shortest path first (SPF) computation frequency controls.
 
 
 ├
[V] isis:ExtIf  This object holds isis information that is operated at a interface level, specific to external interfaces
 
 
 
 ├
[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] nw:RtPathToIf A target relation to the interface information.
 
 
 ├
[V] isis:FmcastTree The ISIS Fabric Multicast(ftag) tree element is a manged object that captures ISIS fabric wide multicast tree membership information.
 
 
 
 ├
[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:NodeIdRec The fabric nodes active for this multicast group element.
 
 
 
 ├
[V] isis:OifListLeaf The outgoing interface list on the leaf switch.
 
 
 
 ├
[V] isis:OifListSpine The outgoing interface list on the spine switch.
 
 
 ├
[V] isis:Gr Per- graceful restart information.
 
 
 
 ├
[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] 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.
 
 
 ├
[V] isis:InterLeakP The inter protocol route leak policy defines distribution of routes from other protocols to IS-IS.
 
 
 
 ├
[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] isis:IntraLeakP Intra protocol leak policy defines distribution of routes from one level to another.
 
 
 
 ├
[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] isis:LeakCtrlP The leak controls related to the number of routes leaked.
 
 
 
 ├
[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] isis:Overload IS-IS overload information.


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:CpEntity The control plane entity abstraction. This object represents a feature or protocol on the switch. For example, OSPF and VPC features.
 
 
 
 ├
[V] l3:ProtEntity A layer 3 protocol entity abstraction.
 
 
 
 
 ├
[V] isis:Entity IS-IS control plane entity information.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: isis:Entity
reference:BinRef monPolDn  (isis:Entity:monPolDn)
           monitoring policy
Defined in: nw:CpEntity
nw:AdminSt
          scalar:Enum8
adminSt  (nw:CpEntity:adminSt)
           The administrative state of the object or policy.
naming:Name
          string:Basic
name  (nw:CpEntity:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64
operErr  (nw:CpEntity:operErr)
          
nw:EntOperSt
          scalar:Enum8
operSt  (nw:CpEntity:operSt)
           The runtime state of the object or policy.
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

adminSt

Type: nw:AdminSt
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





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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
monitoring policy



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: create Category: TopLevelRegular
    Comments:
The name of the object.



operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
sock-err 16ull Socket error Socket errors
init-err 1ull Initialization error Initialization errors
mem-err 2ull Memory error Memory errors
proto-err 32ull Protocol error Protocol errors
ipc-err 4ull IPC error IPC errors
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier





operSt

Type: nw:EntOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 unknown Entity state unknown
enabled 1 enabled Entity enabled
disabled 2 disabled Entity disabled
initializing 3 initializing Entity initializing
failed 4 failed Entity enable failed
DEFAULT enabled(1) enabled Entity enabled





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.