Class fv:TunDefRef (CONCRETE)

Class ID:2063
Class Label: Tunnel
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-protocol-l2]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

A tunnel on the node. This is an internal object.

Naming Rules
RN FORMAT: tundefref-{mac}

    [1] PREFIX=tundefref- PROPERTY = mac




DN FORMAT: 

        Too Many Containers: 154
                


Containers Hierarchies
Too Many containers: 154


Contained Hierarchy
[V] fv:TunDefRef A tunnel on the node. This is an internal object.
 ├
[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] fv:RsHyper A source relation to the hypervisor that controls and monitors the APIC VMs. This is an internal object.
 
 ├
[V] 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.
 ├
[V] fv:RsToFvDomDef 
 
 ├
[V] fv:ByHv 
 
 
 ├
[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] fv:RsToFvPrimaryEncapDef 
 
 ├
[V] fv:ByDom 
 
 
 ├
[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] fv:ByHv 
 
 
 
 ├
[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] fv:RsToNic 
 
 ├
[V] 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.
 ├
[V] fv:RsToTunDef A source relation to a tunnel. This is an internal object.
 ├
[V] fv:RsToVm 
 
 ├
[V] 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.
 ├
[V] fv:RtDestToVPort A target relation to an endpoint. This is an internal object.
 ├
[V] fv:RtSrcToVPort A target relation to a set of endpoints. This is an internal object.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 ├
[V] fv:NwEp Abstract super class.
 
 
 ├
[V] fv:ATp The attachable target point.
 
 
 
 ├
[V] fv:Ep An endpoint.
 
 
 
 
 ├
[V] fv:AEpDef Abstract representation of an endpoint definition.
 
 
 
 
 
 ├
[V] fv:ATunDef The base class for an internal definition of a tunnel.
 
 
 
 
 
 
 ├
[V] fv:TunDefRef A tunnel on the node. This is an internal object.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: fv:TunDefRef
address:MAC mac  (fv:TunDefRef:mac)
           Overrides:fv:ATp:mac
           null
reference:BinRef monPolDn  (fv:TunDefRef:monPolDn)
           The monitoring policy attached to this observable object.
Defined in: fv:ATunDef
tunnel:TunnelQual
          scalar:Enum8
tType  (fv:ATunDef:tType)
           null
Defined in: fv:AEpDef
fv:ClassPref
          scalar:Enum8
classPref  (fv:AEpDef:classPref)
           Classification preference for this EPG within a domain encap: the class-id is dervied based on packet encapsulation (e.g Vlan/VxLAN id) useg: class-id is derived based on other useg/EPGs or dynamically learned mac address in VMM.
reference:BinRef nic  (fv:AEpDef:nic)
          
scalar:Uint64 txId  (fv:AEpDef:txId)
           Indicates the identifier of the transaction in which the user action occurred.
reference:BinRef vm  (fv:AEpDef:vm)
          
fv:VmmSrc
          scalar:Bitmask8
vmmSrc  (fv:AEpDef:vmmSrc)
           NO COMMENTS
Defined in: fv:ATp
base:Encap encap  (fv:ATp:encap)
           The encapsulation (VXLAN or VLAN) to be used for this context.
address:Ip ip  (fv:ATp:ip)
           The IP address.
fv:LcC
          scalar:Bitmask8
lcC  (fv:ATp:lcC)
           How this entity's lifecycle is created, deleted, or modified.
string:Basic uuid  (fv:ATp:uuid)
           The endpoint UUID
Defined in: naming:NamedIdentifiedObject
naming:Id
          scalar:Uint64
id  (naming:NamedIdentifiedObject:id)
           An identifier .
Defined in: naming:NamedObject
naming:Name
          string:Basic
name  (naming:NamedObject:name)
           The name of the object.
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

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





classPref

Type: fv:ClassPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Classification preference for this EPG within a domain encap: the class-id is dervied based on packet encapsulation (e.g Vlan/VxLAN id) useg: class-id is derived based on other useg/EPGs or dynamically learned mac address in VMM.
Constants
encap 0 Packet Encapsulation NO COMMENTS
useg 1 uSeg NO COMMENTS
DEFAULT encap(0) Packet Encapsulation NO 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.



encap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The encapsulation (VXLAN or VLAN) to be used for this context.



id

Type: naming:Id
Primitive Type: scalar:Uint64

Like: naming:Identified:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
An identifier .



ip

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IP address.



lcC

Type: fv:LcC
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
How this entity's lifecycle is created, deleted, or modified.
Constants
vmm 1 vmm instanciated by a trigger from corresponding VMM domain
learned 2 learned learned through network protocol magic
static 4 static statically configured by admin
dynamic 8 dynamic dynamically detected through special HV signalling
802-dot-1x 16 802-dot-1x 802.1x authentication Ep
DEFAULT 0 --- Life Cycle Control specifies how this entity (EP)'s Lifecycle is controlled: created, deleted, modified





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





mac

Type: address:MAC

Overrides:fv:ATp:mac
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
null



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.



name

Type: naming:Name
Primitive Type: string:Basic

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



nic

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
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.






tType

Type: tunnel:TunnelQual
Primitive Type: scalar:Enum8

Like: tunnel:If:tType
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
unknown 0 unknown Unknown
ivxlan 1 ivxlan iVXLAN tunnel
vxlan 2 vxlan VXLAN tunnel
DEFAULT ivxlan(1) ivxlan iVXLAN tunnel





txId

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates the identifier of the transaction in which the user action occurred.



uuid

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The endpoint UUID



vm

Type: reference:BinRef

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



vmmSrc

Type: fv:VmmSrc
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
ignored 0 ignored ignored
dvs 1 dvs dynamically detected through opflex signalling from DVS
avs 2 avs dynamically detected through opflex signalling from AVS
msft 4 msft dynamically detected through opflex signalling from Microsoft VS
ovs 8 ovs dynamically detected through opflexp signalling from OVS
k8s 16 k8s NO COMMENTS
cf 32 cf NO COMMENTS
openshift 64 openshift NO COMMENTS
ave 128 ave NO COMMENTS
DEFAULT ignored(0) ignored ignored