Class fv:L3EpDef (CONCRETE)

Class ID:12963
Class Label: Endpoint
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-connectivity, tenant-epg, tenant-network-profile, tenant-protocol]
Creatable/Deletable: no (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 ]

NO COMMENTS

Naming Rules
RN FORMAT: epdef-{mac}

    [1] PREFIX=epdef- PROPERTY = mac




DN FORMAT: 

[1] uni/ctx-{[ctxDn]}/l3epcont/epdef-{mac}

                


Diagram

Super Mo: fv:AEpDef,
Container Mos: fv:L3EpCont (deletable:no),
Contained Mos: fv:Ip,
Relations From: span:AVDest, span:AVSrc,
Relations To: comp:Hv, nw:PathEp, fv:DomDef, fv:PrimaryEncapDef, comp:Nic, comp:Vm,
Relations: fv:RsHyper, fv:RsL3EpDefToPathEp, fv:RsToFvDomDef, fv:RsToFvPrimaryEncapDef, fv:RsToNic, fv:RsToVm, fv:RtDestToVPort, fv:RtSrcToVPort,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:CtxDef A private L3 network context belonging to a specific tenant. This is an internal representation of the context.
 
 
 
 
 
 
 
 ├
[V] fv:L3EpCont  L3 Ep Container: Contains EndPoints per VRF @@@ This Mo exists only on PE
 
 
 
 
 
 
 
 
 ├
[V] fv:L3EpDef 
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:CtxDef A private L3 network context belonging to a specific tenant. This is an internal representation of the context.
 
 
 ├
[V] fv:L3EpCont  L3 Ep Container: Contains EndPoints per VRF @@@ This Mo exists only on PE
 
 
 
 ├
[V] fv:L3EpDef 


Contained Hierarchy
[V] fv:L3EpDef 
 ├
[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] fv:Ip The IP address of an endpoint.
 
 ├
[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] 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] 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:RtFromEpIp A target relation to the IP address of an endpoint.
 
 ├
[V] fv:RtFromEpIpForEpToEpg A target relation to the IP address of an endpoint.
 
 ├
[V] fv:RtToEpIp A target relation to the IP address of an endpoint.
 
 
 ├
[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)
 
 ├
[V] fv:RtToEpIpForEpToEp A target relation to the IP address of an endpoint.
 
 
 ├
[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)
 
 ├
[V] fv:RtToEpIpForEpgToEp A target relation to the IP address of an endpoint.
 
 
 ├
[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)
 
 ├
[V] fv:RtTrEpExtIpSrc 
 
 ├
[V] fv:RtTrEpIpDst A target relation to the IP address of an endpoint.
 
 ├
[V] fv:RtTrEpIpSrc A target relation to the IP address of an endpoint.
 
 ├
[V] fv:RtTrExtEpIpDst 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[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:RsL3EpDefToPathEp 
 ├
[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: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:L3EpDef 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: fv:L3EpDef
base:Encap encap  (fv:L3EpDef:encap)
           Overrides:fv:ATp:encap
           The port encapsulation.
address:Ip ip  (fv:L3EpDef:ip)
           Overrides:fv:ATp:ip
           The IP address.
nw:IfId
          base:IfIndex
l2If  (fv:L3EpDef:l2If)
           NO COMMENTS
nw:IfId
          base:IfIndex
l3If  (fv:L3EpDef:l3If)
           NO COMMENTS
fv:LcC
          scalar:Bitmask8
lcC  (fv:L3EpDef:lcC)
           Overrides:fv:ATp:lcC
           How this entity's lifecycle is created, deleted, or modified.
address:MAC mac  (fv:L3EpDef:mac)
           Overrides:fv:ATp:mac
           The MAC address.
reference:BinRef monPolDn  (fv:L3EpDef:monPolDn)
           The monitoring policy attached to this observable object.
aib:Owner
          string:Basic
owner  (fv:L3EpDef:owner)
           The owner of the target relay. The DHCP relay is any host that forwards DHCP packets between clients and servers. The relays are used to forward requests and replies between clients and servers when they are not on the same physical subnet.
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.
scalar:Date createTs  (fv:AEpDef:createTs)
           The creation time of the Layer 2 bridge domain.
reference:BinRef host  (fv:AEpDef:host)
           The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.
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
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: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.
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





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





createTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The creation time of the Layer 2 bridge domain.



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

Overrides:fv:ATp:encap
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The port encapsulation.



host

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.



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

Overrides:fv:ATp:ip
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The IP address.



l2If

Type: nw:IfId
Primitive Type: base:IfIndex

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



l3If

Type: nw:IfId
Primitive Type: base:IfIndex

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



lcC

Type: fv:LcC
Primitive Type: scalar:Bitmask8

Overrides:fv:ATp:lcC
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
poe 32 poe Power Over Ethernet 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:
The MAC address.



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:



owner

Type: aib:Owner
Primitive Type: string:Basic

Like: aib:AdjOwner:owner
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The owner of the target relay. The DHCP relay is any host that forwards DHCP packets between clients and servers. The relays are used to forward requests and replies between clients and servers when they are not on the same physical subnet.



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.






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