Class CIM_TokenBucketMeterService
extends CIM_MeterService

This is a concrete subclass of the MeterService class that represents the metering of network traffic using a token bucket meter. Two types of token bucket meters are defined using this class - a simple, two-parameter bucket meter, and a multi-stage meter. A simple token bucket usually has two parameters, an average token rate and a burst size, and has two conformance levels: 'conforming' and 'non-conforming'. This class also defines an excess burst size, which enables the meter to have three conformance levels ('conforming', 'partially conforming', and 'non-conforming'). In this case, packets that exceed the excess burst size are deemed non-conforming, while packets that exceed the smaller burst size but are less than the excess burst size are deemed partially conforming.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_ConditioningService
   |
   +--CIM_MeterService
   |
   +--CIM_TokenBucketMeterService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis is a concrete subclass of the MeterService class that represents the metering of network traffic using a token bucket meter. Two types of token bucket meters are defined using this class - a simple, two-parameter bucket meter, and a multi-stage meter. A simple token bucket usually has two parameters, an average token rate and a burst size, and has two conformance levels: 'conforming' and 'non-conforming'. This class also defines an excess burst size, which enables the meter to have three conformance levels ('conforming', 'partially conforming', and 'non-conforming'). In this case, packets that exceed the excess burst size are deemed non-conforming, while packets that exceed the smaller burst size but are less than the excess burst size are deemed partially conforming.
UMLPackagePathstringCIM::Network::QoS
Versionstring2.7.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AverageRateuint32
DescriptionstringThis property is a 32-bit unsigned integer that is used to define the committed rate of the meter. The value is expressed in kilobits per second.
PUnitstringbit / second * 10^3
UnitsstringKiloBits per Second
BurstSizeuint32
DescriptionstringThis property is a 32-bit unsigned integer that is used to define the maximum number of tokens available for the committed rate (specified by the AverageRate property). The value is specified in kilobytes.
PUnitstringbyte * 10^3
UnitsstringKiloBytes
ExcessBurstSizeuint32
DescriptionstringThis property is a 32-bit unsigned integer that is used to define the maximum number of tokens available for the peak rate (specified by the PeakRate property). The value is specified in kilobytes.
PUnitstringbyte * 10^3
UnitsstringKiloBytes
PeakRateuint32
DescriptionstringThis attribute is a 32-bit unsigned integer that is used to define the peak rate of the meter. The value is expressed in kilobits per second.
PUnitstringbit / second * 10^3
UnitsstringKiloBits per Second

Inherited Properties

NameData Type
Captionstring
CommunicationStatusuint16
ConformanceLevelsuint16
CreationClassNamestring
Descriptionstring
DetailedStatusuint16
ElementNamestring
Enabledboolean
EnabledDefaultuint16
EnabledStateuint16
Generationuint64
HealthStateuint16
InstallDatedatetime
InstanceIDstring
LoSIDstring
LoSOrgIDstring
MeterTypeuint16
Namestring
OperatingStatusuint16
OtherEnabledStatestring
OtherMeterTypestring
PrimaryOwnerContactstring
PrimaryOwnerNamestring
PrimaryStatusuint16
RequestedStateuint16
Startedboolean
StartModestring
Statusstring
SystemCreationClassNamestring
SystemNamestring
TimeOfLastStateChangedatetime
TransitioningToStateuint16
AvailableRequestedStatesuint16[]
OperationalStatusuint16[]
StatusDescriptionsstring[]

Class Methods

Inherited Class Methods

NameReturn Type
ChangeAffectedElementsAssignedSequenceuint32
RequestStateChangeuint32
StartServiceuint32
StopServiceuint32