Class fv:EpRetPol (CONCRETE)

Class ID:1893
Class Label: End Point Retention Policy
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model
Write Access: [admin, tenant-connectivity-l2]
Read Access: [admin, tenant-connectivity-l2, tenant-connectivity-l3]
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 ]

RN FORMAT: epRPol-{name}

    [1] PREFIX=epRPol- PROPERTY = name




DN FORMAT: 

[1] uni/tn-{name}/epRPol-{name}

                

Diagram

Super Mo: fv:AEpRetPol, Container Mos: fv:Tenant (deletable:yes), Contained Mos: tag:Annotation, tag:Tag, Relations From: fv:ABDPol, fv:Ctx, Relations: fv:RtBdToEpRet, fv:RtCtxToEpRet,

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.        ├ ctx:Local The local Context.          ├ ctx:Application The context application.            ├ pol:Uni Represents policy definition/resolution universe.              ├ fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.                ├ fv:EpRetPol The endpoint retention policy provides the parameters for the lifecycle of the endpoints. top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ pol:Uni Represents policy definition/resolution universe.    ├ fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.      ├ fv:EpRetPol The endpoint retention policy provides the parameters for the lifecycle of the endpoints.

Contained Hierarchy

fv:EpRetPol The endpoint retention policy provides the parameters for the lifecycle of the endpoints.  ├ 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:RtBdToEpRet A target relation to the endpoint retention policy providing the parameters for the lifecycle of the endpoint group. This is an internal object.  ├ fv:RtCtxToEpRet A target relation to the endpoint retention policy that provides the parameters for the lifecycle of the endpoint group. This is an internal object.  ├ tag:Annotation   ├ tag:Tag

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.  ├ pol:Obj Represents a generic policy object.    ├ pol:Def Represents self-contained policy document.      ├ fabric:ProtoPol A base class for protocol policies.        ├ fabric:ProtoDomPol A base class for context-level protocol policies.          ├ fabric:L2DomPol A base class for layer 2 context-level policies.            ├ fv:AEpRetPol Abstract of an endpoint retention policy.              ├ fv:EpRetPol The endpoint retention policy provides the parameters for the lifecycle of the endpoints.

                fv:EpRetPol:creation__fv_EpRetPol

                fv:EpRetPol:modification__fv_EpRetPol

                fv:EpRetPol:deletion__fv_EpRetPol

                

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

NO COMMENTS

bounceAgeIntvl

Type: l2:BounceEpAgeIntvl
Primitive Type: scalar:Uint16

Like: l2:EpRetPol:bounceAgeIntvl
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0
    Range:  min: 150  max: 0xffff

The aging interval for a bounce entry. When an endpoint (VM) migrates to another switch, the endpoint is marked as bouncing for the specified aging interval and is deleted afterwards.

bounceTrig

Type: l2:BounceTrig
Primitive Type: scalar:Bitmask8

Like: l2:EpRetPol:bounceTrig
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Specifies whether to install the bounce entry by RARP flood or by COOP protocol.

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

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

Delete or ignore. For internal use only.

descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+

Specifies a description of the policy definition.

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.

extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

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

NO COMMENTS

holdIntvl

Type: l2:HoldIntvl
Primitive Type: scalar:Uint16

Like: l2:EpRetPol:holdIntvl
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 5  max: 0xffff

A time period during which new endpoint learn events will not be honored. This interval is triggered when the maximum endpoint move frequency is exceeded.

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.

localEpAgeIntvl

Type: l2:LocalEpAgeIntvl
Primitive Type: scalar:Uint16

Like: l2:EpRetPol:localEpAgeIntvl
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0
    Range:  min: 120  max: 0xffff

The aging interval for all local endpoints learned in this bridge domain. When 75% of the interval is reached, 3 ARP requests are sent to verify the existence of the endpoint. If no response is received, the endpoint is deleted.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

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

The time when this object was last modified.

moveFreq

Type: l2:MoveFreq
Primitive Type: scalar:Uint16

Like: l2:EpRetPol:moveFreq
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff

A maximum allowed number of endpoint moves per second. If the move frequency is exceeded, the hold interval is triggered, and new endpoint learn events will not be honored until after the hold interval expires.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

The name for the endpoint retention policy.

nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+

NO COMMENTS

ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+

The key for enabling clients to own their data for entity correlation.

ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+

A tag for enabling clients to add their own data. For example, to indicate who created this object.

remoteEpAgeIntvl

Type: l2:RemoteEpAgeIntvl
Primitive Type: scalar:Uint16

Like: l2:EpRetPol:remoteEpAgeIntvl
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0
    Range:  min: 120  max: 0xffff

The aging interval for all remote endpoints learned in this bridge domain.

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.

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.

uid

Type: scalar:Uint16

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

A unique identifier for this object.