Class tunnel:If (CONCRETE)

Class ID:3677
Class Label: Tunnel Interface
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l1, access-connectivity-l3, admin, fabric-connectivity-l3, fabric-connectivity-mgmt, fabric-connectivity-util, fabric-equipment, ops, tenant-connectivity-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: true ]

RN FORMAT: tunnel-{[id]}

    [1] PREFIX=tunnel- PROPERTY = id




DN FORMAT: 

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

[1] sys/tunnel-{[id]}

                

Diagram

Super Mo: nw:LogicalIf, Container Mos: top:System (deletable:no), Contained Mos: ac:LatencyAvg, ac:LatencyHist, eltm:TnnlIf, fv:DEp, fv:VNode, opflex:IDEp, opflex:ODev, tunnel:Bank, tunnel:Cons, tunnel:PortIf, Relations From: nw:PathEp, Relations To: l1:PhysIf, leqpt:LooseNode, Relations: nw:RtPathToIf, tunnel:RsTunnelMbrIfs, tunnel:RsTunnelToLooseNode,

Containers Hierarchies

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ 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...          ├ tunnel:If A tunnel interface. top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ 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...    ├ tunnel:If A tunnel interface.

Contained Hierarchy

tunnel:If A tunnel interface.  ├ ac:LatencyAvg Average Latency Data.  ├ ac:LatencyHist  MO containing histogram data for latency  ├ eltm:TnnlIf   ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ 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.  ├ fv:DEp A dynamically-learned endpoint on the switch.    ├ fv:RsHyper A source relation to the hypervisor that controls and monitors the APIC VMs. This is an internal object.      ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.    ├ fv:RsToNic       ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.    ├ fv:RsToVm       ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.    ├ fv:RtDestToVPort A target relation to an endpoint. This is an internal object.    ├ fv:RtSrcToVPort A target relation to a set of endpoints. This is an internal object.  ├ fv:VNode An opflex-capable virtual node that is connected to the fabric.    ├ fv:RsHostprotPol  Relation to hostprot policies used by this device.    ├ fv:RsLNode A source relation to the logical node. This is an internal object.    ├ fv:RsOpflexHv  Relation to the hypervisor in the IFC for UI display purposes. Use the new realtion VNodeToHv. This exists for backward compatibility.    ├ fv:RsVNodeToHv  Relation to the hypervisor in the IFC for UI display purposes This is needed for stats as multiple ODevs can point to the same Hv.    ├ fv:RtVNode A target relation to the VNode that contains the endpoint. This is an internal object.  ├ health:Inst A base class for a health score instance.(Switch only)  ├ nw:RtPathToIf A target relation to the interface information.  ├ opflex:IDEp This is generated and used only by internal processes.    ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ 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.    ├ fv:RsHyper A source relation to the hypervisor that controls and monitors the APIC VMs. This is an internal object.      ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.    ├ fv:RsToNic       ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.    ├ fv:RsToVm       ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.    ├ fv:RtDestToVPort A target relation to an endpoint. This is an internal object.    ├ fv:RtSrcToVPort A target relation to a set of endpoints. This is an internal object.    ├ fv:VDEp A virtual datacenter endpoint.      ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ 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.      ├ fv:RsHyper A source relation to the hypervisor that controls and monitors the APIC VMs. This is an internal object.        ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.      ├ fv:RsToNic         ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.      ├ fv:RsToVm         ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.      ├ fv:RsVNode A source relation to an opflex-capable virtual node that is connected to the fabric. This is an internal object.      ├ fv:RtDestToVPort A target relation to an endpoint. This is an internal object.      ├ fv:RtSrcToVPort A target relation to a set of endpoints. This is an internal object.      ├ health:Inst A base class for a health score instance.(Switch only)    ├ health:Inst A base class for a health score instance.(Switch only)    ├ opflex:EncapCont       ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ 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.      ├ health:Inst A base class for a health score instance.(Switch only)      ├ opflex:PathAtt         ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.        ├ 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.        ├ fv:VDEp A virtual datacenter endpoint.          ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.          ├ 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.          ├ fv:RsHyper A source relation to the hypervisor that controls and monitors the APIC VMs. This is an internal object.            ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.          ├ fv:RsToNic             ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.          ├ fv:RsToVm             ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.          ├ fv:RsVNode A source relation to an opflex-capable virtual node that is connected to the fabric. This is an internal object.          ├ fv:RtDestToVPort A target relation to an endpoint. This is an internal object.          ├ fv:RtSrcToVPort A target relation to a set of endpoints. This is an internal object.          ├ health:Inst A base class for a health score instance.(Switch only)        ├ health:Inst A base class for a health score instance.(Switch only)    ├ opflex:IDEpCntr This is generated and used only by internal processes.    ├ opflex:IDEpEpPDRef  EpPD ref under the IDEp    ├ opflex:IDEpFaultInfo       ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ 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.      ├ health:Inst A base class for a health score instance.(Switch only)    ├ opflex:IDEpLabel     ├ opflex:IDEpScopeCont       ├ 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.      ├ opflex:IDEpScope         ├ 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.    ├ opflex:PathAtt       ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ 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.      ├ fv:VDEp A virtual datacenter endpoint.        ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.        ├ 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.        ├ fv:RsHyper A source relation to the hypervisor that controls and monitors the APIC VMs. This is an internal object.          ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.        ├ fv:RsToNic           ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.        ├ fv:RsToVm           ├ fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.        ├ fv:RsVNode A source relation to an opflex-capable virtual node that is connected to the fabric. This is an internal object.        ├ fv:RtDestToVPort A target relation to an endpoint. This is an internal object.        ├ fv:RtSrcToVPort A target relation to a set of endpoints. This is an internal object.        ├ health:Inst A base class for a health score instance.(Switch only)      ├ health:Inst A base class for a health score instance.(Switch only)  ├ opflex:ODev This is generated and used only by internal processes.    ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ 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.    ├ fv:VNode An opflex-capable virtual node that is connected to the fabric.      ├ fv:RsHostprotPol  Relation to hostprot policies used by this device.      ├ fv:RsLNode A source relation to the logical node. This is an internal object.      ├ fv:RsOpflexHv  Relation to the hypervisor in the IFC for UI display purposes. Use the new realtion VNodeToHv. This exists for backward compatibility.      ├ fv:RsVNodeToHv  Relation to the hypervisor in the IFC for UI display purposes This is needed for stats as multiple ODevs can point to the same Hv.      ├ fv:RtVNode A target relation to the VNode that contains the endpoint. This is an internal object.    ├ health:Inst A base class for a health score instance.(Switch only)    ├ opflex:ODevCap This is generated and used only by internal processes.    ├ opflex:ODevCliCmdCont       ├ opflex:ODevCliCmdSession         ├ opflex:ODevCliCmdReq           ├ opflex:ODevCliCmdResp     ├ opflex:ODevFaultInfo       ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ 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.      ├ health:Inst A base class for a health score instance.(Switch only)    ├ opflex:OPNic       ├ opflex:ONic     ├ opflex:OVm     ├ opflex:RtTsODev  Relation to source fabric node  ├ tunnel:Bank A bank. Each port interface under tunnel has two sets of banks for counting the packets and bytes. This object is for statistics only.    ├ tunnel:EgrTep An egress tunnel endpoint counter.    ├ tunnel:IngrTep An ingress tunnel endpoint counter.  ├ tunnel:Cons  tunnel:Cons: Used for reference counting the consumers responsible for creation of this tunnel    ├ 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.  ├ tunnel:PortIf A port interface. This object is for stats purposes only. The tunnel stats on a given physical port are counted. These port objects will be created by default wherever the tunnel can exit out. For example, all north bound tunnels will have the fabric ports created under it.    ├ tunnel:Bank A bank. Each port interface under tunnel has two sets of banks for counting the packets and bytes. This object is for statistics only.      ├ tunnel:EgrTep An egress tunnel endpoint counter.      ├ tunnel:IngrTep An ingress tunnel endpoint counter.  ├ tunnel:RsTunnelMbrIfs A source relation to a layer 1 physical Ethernet interface. Note that this relation is an internal object.  ├ tunnel:RsTunnelToLooseNode A source relation to an external connected node (i.e. blade switch). Note that this relation is an internal object.

Inheritance

nw:Item Ignore.  ├ nw:Conn A connection abstraction.    ├ nw:Ep A static endpoint.      ├ nw:ConnEp A connection endpoint abstraction.        ├ nw:If The interface information.          ├ nw:LogicalIf A logical interface abstraction.            ├ tunnel:If A tunnel interface.

                tunnel:If:tunnel_If_mtuCfgd

                tunnel:If:tunnel_If_operStChange

                

                tunnel:If:destIPUnres

                tunnel:If:destUnreach

                tunnel:If:hwProgFail

                tunnel:If:tmCfgCtrl

                tunnel:If:tunnelDown

                

adminSt

Type: tunnel:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The administrative state of the interface.

cfgdMtu

Type: tunnel:ConfMtu
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The routed VLAN interface configured maximum transmission unit (MTU).

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

delInProg

Type: scalar:Bool

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

descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

dest

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The transmission destination identifier.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

id

Type: nw:IfId
Primitive Type: base:IfIndex

Overrides:nw:If:id

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular

The routed VLAN interface identifier.

idRequestorDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Tunnel Id Requestor Dn

iod

Type: scalar:Uint32

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

Specifies the IOD.

keepAlvIntvl

Type: tunnel:KeepAlvIntvl
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The interval time between sending keepalive messages.

keepAlvRetries

Type: tunnel:KeepAlvRetries
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The configured interval before sending another series of keep alive messages.

lcC

Type: tunnel:LcC
Primitive Type: scalar:Bitmask8

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

How this entity's lifecycle is created, deleted, or modified.

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A value that indicates how this object was created. For internal use only.

mac

Type: address:MAC

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The MAC address.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The time when this object was last modified.

monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

The name of the object.

operSt

Type: tunnel:OperSt
Primitive Type: scalar:Enum8

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

The runtime state of the routed VLAN interface.

operStQual

Type: tunnel:OperStQual
Primitive Type: scalar:Enum8

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

The chassis operational status qualifier.

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

src

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The source node IP address.

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus

The upgrade status. This property is for internal use only.

tLayer

Type: tunnel:LayerT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The layer for the tunnel interface.

tType

Type: tunnel:TunnelQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The type of target.

tmCfgFailedBmp

Type: scalar:Bitmask64

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

tmCfgFailedTs

Type: scalar:Time

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

tmCfgState

Type: scalar:UByte

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

type

Type: tunnel:EpT
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The specific type of the routed vlan interface.

underlayVrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

VRF for Underlay Tunnel (valid only for underlay-mcast type tunnels)

vrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The interface VRF name. This name can be up to 64 alphanumeric characters.