.. Class Doc file

class cobra.model.stats.HierColl
================================
.. class:: cobra.model.stats.HierColl

The statistics collection policy, which enables you to determine how often the system collects data and to specify how far back in time data should be collected.

    Containers:
      * :class:`cobra.model.mon.CommonPol`
      * :class:`cobra.model.mon.InfraPol`
      * :class:`cobra.model.mon.EPGTarget`
      * :class:`cobra.model.mon.FabricPol`
      * :class:`cobra.model.mon.EPGPol`
      * :class:`cobra.model.mon.InfraTarget`
      * :class:`cobra.model.mon.FabricTarget`

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

    Properties:
      - adminState : The administrative state of the data collection policy. The policy can be enabled or disabled.

          + 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 : Additional descriptive information about the object.

          + 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

      - granularity : The length of time the system collects data.

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

      - histRet : The history retention policy. The retention policy is grouped into time periods that specify how far back the data should be collected.

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

      - 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

      - name : null

          + 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