Class stats:AColl (ABSTRACT)

Class ID:55
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, ops]
Read Access: [admin, ops]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: Common, EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

A superclass that configures collection rules according to the granularity of the statistics.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: pol:Comp,
Sub Mos: stats:Coll, stats:HierColl,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] stats:AColl A superclass that configures collection rules according to the granularity of the statistics.
 
 
 
 ├
[V] stats:Coll The collection configuration policy, which configures the collection policy according to the granularity of the statistics.. This is also a container for threshold policies for the statistic granularity.
 
 
 
 ├
[V] 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.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: stats:AColl
stats:AdminState
          scalar:Enum8
adminState  (stats:AColl:adminState)
          
stats:Granularity
          scalar:Enum8
granularity  (stats:AColl:granularity)
          
stats:HistRet
          scalar:Enum8
histRet  (stats:AColl:histRet)
          
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

adminState

Type: stats:AdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
inherited 0 inherited NO COMMENTS
enabled 1 enabled NO COMMENTS
disabled 2 disabled NO COMMENTS
DEFAULT inherited(0) inherited NO COMMENTS





childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





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\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies the description of a policy component.



dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



granularity

Type: stats:Granularity
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
5min 0 5 Minute NO COMMENTS
15min 1 15 Minute NO COMMENTS
1h 2 1 Hour NO COMMENTS
1d 3 1 Day NO COMMENTS
1w 4 1 Week NO COMMENTS
1mo 5 1 Month NO COMMENTS
1qtr 6 1 Quarter NO COMMENTS
1year 7 1 Year NO COMMENTS
DEFAULT 5min(0) 5 Minute NO COMMENTS





histRet

Type: stats:HistRet
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
inherited 0 inherited NO COMMENTS
none 1 No Retention NO COMMENTS
5min 2 5 Minutes Retention NO COMMENTS
15min 3 15 Minutes Retention NO COMMENTS
1h 4 1 Hour Retention NO COMMENTS
1d 5 1 Day Retention NO COMMENTS
1w 6 1 Week Retention NO COMMENTS
10d 7 10 Days Retention NO COMMENTS
1mo 8 1 Month Retention NO COMMENTS
1qtr 9 1 Quarter Retention NO COMMENTS
1year 10 1 Year Retention NO COMMENTS
2year 11 2 Years Retention NO COMMENTS
3year 12 3 Years Retention NO COMMENTS
DEFAULT inherited(0) inherited NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

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



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_.-]+
    Comments:
NO COMMENTS



rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
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
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.