.. Class Doc file

class cobra.model.bgp.PeerPfxPol
================================
.. class:: cobra.model.bgp.PeerPfxPol

The peer prefix policy defines how many prefixes can be received from a neighbor and the action to take when the number of allowed prefixes is exceeded. This feature is commonly used for external BGP peers, but can also be  applied to internal BGP peers.

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

    Containment:
      * :class:`cobra.model.bgp.RtPeerPfxPol`
      * :class:`cobra.model.fault.Delegate`

    Properties:
      - action : Action to be performed when the maximum prefix limit is reached.

          + 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

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

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

      - maxPfx : Maximum number of prefixes allowed from the peer.

          + 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

      - name : The peer prefix policy name. This name can be up to 64 alphanumeric characters.

          + 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

      - restartTime : The period of time in minutes before restarting the peer when the prefix limit is reached.

          + 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

      - thresh : The threshold percentage of the maximum number of prefixes before a warning is issued. For example, if the maximum number of prefixes is 10 and the threshold is 70%, a warning is issued when the number of prefixes exceeds 7 (70%). 

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

      - uid : A unique identifier for this object.

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