Class l2:EpRetPol (CONCRETE)

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

An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.

Naming Rules
RN FORMAT: epret

    [1] PREFIX=epret


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ctx-{[encap]}/epret

[1] sys/ctx-{[encap]}/epret

[2] topology/pod-{id}/node-{id}/sys/ctxsubstitute-{[encap]}/bd-{[fabEncap]}/epret

[3] sys/ctxsubstitute-{[encap]}/bd-{[fabEncap]}/epret

[4] topology/pod-{id}/node-{id}/sys/inst-{name}/bd-{[fabEncap]}/epret

[5] sys/inst-{name}/bd-{[fabEncap]}/epret

[6] topology/pod-{id}/node-{id}/sys/ctx-{[encap]}/bd-{[fabEncap]}/epret

[7] sys/ctx-{[encap]}/bd-{[fabEncap]}/epret

                


Diagram

Super Mo: pol:Instr,
Container Mos: l2:BD (deletable:yes), l3:Ctx (deletable:yes),


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] l3:Ctx The tenant context information is equivalent to a virtual routing and forwarding (VRF) instance created for the tenant's L3 network. Similar to a VRF in traditional Cisco routers, the tenant context isolates the IP addresses of the tenant, allowing different tenants to have overlapping IP addresses.
 
 
 
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.
[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] l3:Ctx The tenant context information is equivalent to a virtual routing and forwarding (VRF) instance created for the tenant's L3 network. Similar to a VRF in traditional Cisco routers, the tenant context isolates the IP addresses of the tenant, allowing different tenants to have overlapping IP addresses.
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.
[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] l3:CtxSubstitute  Tenant context object substitute. Its needed for internal PE purposes but it doesnt instantiate any VRF in the node.
 
 
 
 
 
 ├
[V] l2:BD The Layer 2 Bridge-domain identifies the boundary of a tenant’s bridged/layer 2 traffic. This is similar to a VLAN in a traditional layer 2 switched network.
 
 
 
 
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.
[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] l3:CtxSubstitute  Tenant context object substitute. Its needed for internal PE purposes but it doesnt instantiate any VRF in the node.
 
 
 ├
[V] l2:BD The Layer 2 Bridge-domain identifies the boundary of a tenant’s bridged/layer 2 traffic. This is similar to a VLAN in a traditional layer 2 switched network.
 
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.
[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] l3:Inst The infra VRF is created for the iNXOS fabric infrastructure. All communications between fabric elements, such as spine, leaf and vleaf, take place in this VRF.
 
 
 
 
 
 ├
[V] l2:BD The Layer 2 Bridge-domain identifies the boundary of a tenant’s bridged/layer 2 traffic. This is similar to a VLAN in a traditional layer 2 switched network.
 
 
 
 
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.
[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] l3:Inst The infra VRF is created for the iNXOS fabric infrastructure. All communications between fabric elements, such as spine, leaf and vleaf, take place in this VRF.
 
 
 ├
[V] l2:BD The Layer 2 Bridge-domain identifies the boundary of a tenant’s bridged/layer 2 traffic. This is similar to a VLAN in a traditional layer 2 switched network.
 
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.
[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] l3:Ctx The tenant context information is equivalent to a virtual routing and forwarding (VRF) instance created for the tenant's L3 network. Similar to a VRF in traditional Cisco routers, the tenant context isolates the IP addresses of the tenant, allowing different tenants to have overlapping IP addresses.
 
 
 
 
 
 ├
[V] l2:BD The Layer 2 Bridge-domain identifies the boundary of a tenant’s bridged/layer 2 traffic. This is similar to a VLAN in a traditional layer 2 switched network.
 
 
 
 
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.
[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] l3:Ctx The tenant context information is equivalent to a virtual routing and forwarding (VRF) instance created for the tenant's L3 network. Similar to a VRF in traditional Cisco routers, the tenant context isolates the IP addresses of the tenant, allowing different tenants to have overlapping IP addresses.
 
 
 ├
[V] l2:BD The Layer 2 Bridge-domain identifies the boundary of a tenant’s bridged/layer 2 traffic. This is similar to a VLAN in a traditional layer 2 switched network.
 
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.


Contained Hierarchy
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.
 ├
[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.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Instr Represents a policy control instrumentation object.
 
 
 ├
[V] l2:EpRetPol An endpoint retention policy identifying the duration of how long information is kept about the remote endpoint. This is expressed through a set of triggering and ageing control parameters.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: l2:EpRetPol
l2:BounceEpAgeIntvl
          scalar:Uint16
bounceAgeIntvl  (l2:EpRetPol:bounceAgeIntvl)
           Represents aging interval for bounce entry @@@ Used when the Ep (VM) is moving from one TOR @@@ to another TOR. Ep is marked as bouncing for the @@@ specified age interval and is deleted afterwards
l2:BounceTrig
          scalar:Bitmask8
bounceTrig  (l2:EpRetPol:bounceTrig)
           Bounce trigger
l2:HoldIntvl
          scalar:Uint16
holdIntvl  (l2:EpRetPol:holdIntvl)
           If the EP move frequency is exceeded
l2:LocalEpAgeIntvl
          scalar:Uint16
localEpAgeIntvl  (l2:EpRetPol:localEpAgeIntvl)
           This represents aging interval for all local endpoints learned in this BD. Once we reach 75% of this interval is reached
l2:MoveFreq
          scalar:Uint16
moveFreq  (l2:EpRetPol:moveFreq)
           EP move frequency
l2:RemoteEpAgeIntvl
          scalar:Uint16
remoteEpAgeIntvl  (l2:EpRetPol:remoteEpAgeIntvl)
           This represents aging interval for all remote endpoints learned in this BD. The remote endpoints are learned through conversational learning
Defined in: pol:Instr
naming:Descr
          string:Basic
descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
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: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

bounceAgeIntvl

Type: l2:BounceEpAgeIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents aging interval for bounce entry @@@ Used when the Ep (VM) is moving from one TOR @@@ to another TOR. Ep is marked as bouncing for the @@@ specified age interval and is deleted afterwards
Constants
infinite 0 Infinite NO COMMENTS
defaultValue 630 --- NO COMMENTS





bounceTrig

Type: l2:BounceTrig
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Bounce trigger
Constants
rarp-flood 1 RARP flooding RARP Flooding
protocol 2 Protocol through protocol magic
DEFAULT protocol(2) Protocol through protocol magic





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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.



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.



holdIntvl

Type: l2:HoldIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
If the EP move frequency is exceeded
Constants
defaultValue 300 --- 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





localEpAgeIntvl

Type: l2:LocalEpAgeIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
This represents aging interval for all local endpoints learned in this BD. Once we reach 75% of this interval is reached
Constants
infinite 0 Infinite NO COMMENTS
defaultValue 900 --- 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





moveFreq

Type: l2:MoveFreq
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
EP move frequency
Constants
none 0 No Move Frequency is Enforced NO COMMENTS
defaultValue 256 --- NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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



remoteEpAgeIntvl

Type: l2:RemoteEpAgeIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
This represents aging interval for all remote endpoints learned in this BD. The remote endpoints are learned through conversational learning
Constants
infinite 0 Infinite NO COMMENTS
defaultValue 300 --- NO 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.