.. Class Doc file

class cobra.model.fv.EpRetPol
=============================
.. class:: cobra.model.fv.EpRetPol

The endpoint retention policy provides the parameters for the lifecycle of the endpoints.

    Containers:
      * :class:`cobra.model.fv.Tenant`

    Containment:
      * :class:`cobra.model.fv.RtBdToEpRet`
      * :class:`cobra.model.fault.Delegate`
      * :class:`cobra.model.fv.RtCtxToEpRet`

    Properties:
      - bounceAgeIntvl : 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. Note: Packets will be dropped if the Bounce Entry Aging Interval time is set to less than the Remote End Point Aging Interval time.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - childAction : Delete or ignore. For internal use only.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - descr : Specifies a description of the policy definition.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: True
          + isConfig: False
          + isImplicit: True

      - holdIntvl : 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.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - localEpAgeIntvl : 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.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - modTs : The time when this object was last modified.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - moveFreq : 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.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - name : The name for the endpoint retention policy.

          + isNaming: True
          + isCreateOnly: True
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

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

          + isNaming: False
          + isCreateOnly: True
          + isConfig: False
          + isImplicit: True

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

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - uid : A unique identifier for this object.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True