.. Class Doc file

class cobra.model.lbp.Pol
=========================
.. class:: cobra.model.lbp.Pol

The load balancing policy options for balancing traffic among the available uplink ports. Static hash load balancing is the traditional load balancing mechanism used in networks where each flow is allocated to an uplink based on a hash of its 5-tuple. This load balancing gives a distribution of flows across the available links that is roughly even. Usually, with a large number of flows, the even distribution of flows results in an even distribution of bandwidth as well. However, if a few flows are much larger than the rest, static load balancing might give suboptimal results.

    Containers:
      * :class:`cobra.model.fabric.Inst`

    Containment:
      * :class:`cobra.model.lbp.RtResLbPol`
      * :class:`cobra.model.fault.Delegate`

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

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

      - descr : Additional descriptive information about the object.

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

      - dlbMode : The dynamic load balancer (DLB) mode adjusts the traffic allocations according to congestion levels. It measures the congestion across the available paths and places the flows on the least congested paths, which results in an optimal or near optimal placement of the data.  DLB can be configured to place traffic on the available uplinks using the granularity of flows or of flowlets. Flowlets are bursts of packets from a flow that are separated by intervals.

          + 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 : Indicates how this object was created.

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

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

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

      - mode : The load balancer administrative state. In all modes of load balancing, static or dynamic, the traffic is sent only on those uplinks or paths that meet the criteria for equal cost multipath (ECMP); these paths are equal and the lowest cost from a routing perspective.

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

      - name : The name of the load balancing 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

      - pri : Dynamic Packet Prioritization (DPP) prioritizes short flows higher than long flows; a short flow is less than approximately 15 packets. Short flows are more sensitive to latency than long ones. DPP can improve overall application performance. 

          + 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