Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class policer:Class (ABSTRACT)

Class ID:2344
Class Label: Class
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-qos, admin]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

A container for the policer class policy.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: pol:Instr,
Sub Mos: copp:Class,


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:Instr Represents a policy control instrumentation object.
 
 		 
 		 ├
 		[V] policer:Class A container for the policer class policy.
 
 		 
 		 
 		 ├
 		[V] copp:Class Represents a control plane policing (COPP) policy class, which contains a set of rules describing policer rates.


Events


Faults


Fsms


Properties Summary
Defined in: policer:Class
policer:Burst
          scalar:Uint64 		burst  (policer:Class:burst)
           A committed burst size. This is the number of packets allowed at line rate during a burst.
policer:BurstUnit
          scalar:Enum8 		burstUnit  (policer:Class:burstUnit)
           Busrt unit - none, Kilo, Mega, Giga, ms, us
scalar:Uint16 defaultBurst  (policer:Class:defaultBurst)
           Default Burst for aggregate COPP policer (in packets)
scalar:Uint64 defaultRate  (policer:Class:defaultRate)
           Default Rate for aggregate COPP policer (in pps)
policer:PolicerLevel
          scalar:Uint16 		level  (policer:Class:level)
           The applied priority level of a route control profile. This is an internal property.
scalar:Uint16 maxBurst  (policer:Class:maxBurst)
           Maximum Burst for aggregate COPP policer (in packets)
scalar:Uint64 maxRate  (policer:Class:maxRate)
           Maximum Rate for aggregate COPP policer (in pps)
scalar:Uint16 minBurst  (policer:Class:minBurst)
           Minimum Burst for aggregate COPP policer (in packets)
scalar:Uint64 minRate  (policer:Class:minRate)
           Minimum Rate for aggregate COPP policer (in pps)
policer:Mode
          scalar:Enum8 		mode  (policer:Class:mode)
           The BGP Domain mode.
policer:Rate
          scalar:Uint64 		rate  (policer:Class:rate)
           An allowed rate. This is the committed rate at which the packets are allowed into the system (raw NTPD format).
policer:RateUnit
          scalar:Enum8 		rateUnit  (policer:Class:rateUnit)
           Rate unit - none, Kilo, Mega, Giga
policer:PolicerType
          scalar:Uint16 		type  (policer:Class:type)
           The specific type of the object or component.
Defined in: pol:Instr
naming:Descr
          string:Basic 		descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
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

burst

Type: policer:Burst
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A committed burst size. This is the number of packets allowed at line rate during a burst.
Constants
unspecified 0xffffffffffffffffull Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffffffffffull) Unspecified NO COMMENTS




burstUnit

Type: policer:BurstUnit
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Busrt unit - none, Kilo, Mega, Giga, ms, us
Constants
unspecified 0 Bytes/Packets NO COMMENTS
kilo 1 Kilo Bytes/Packets NO COMMENTS
mega 2 Mega Bytes/Packets NO COMMENTS
giga 3 Giga Bytes/Packets NO COMMENTS
msec 4 Milli Seconds NO COMMENTS
usec 5 Micro Seconds NO COMMENTS
DEFAULT unspecified(0) Bytes/Packets 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




defaultBurst

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Default Burst for aggregate COPP policer (in packets)


defaultRate

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Default Rate for aggregate COPP policer (in pps)


descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.


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.


level

Type: policer:PolicerLevel
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The applied priority level of a route control profile. This is an internal property.
Constants
per-proto 0 per proto NO COMMENTS
per-proto-per-intf 1 per proto per intf NO COMMENTS
DEFAULT per-proto(0) per proto NO COMMENTS




maxBurst

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Maximum Burst for aggregate COPP policer (in packets)


maxRate

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Maximum Rate for aggregate COPP policer (in pps)


minBurst

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Minimum Burst for aggregate COPP policer (in packets)


minRate

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Minimum Rate for aggregate COPP policer (in pps)


mode

Type: policer:Mode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The BGP Domain mode.
Constants
bit 1 Bit policer NO COMMENTS
packet 2 Packet Policer NO COMMENTS
DEFAULT packet(2) Packet Policer NO COMMENTS




name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
null


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS


rate

Type: policer:Rate
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An allowed rate. This is the committed rate at which the packets are allowed into the system (raw NTPD format).


rateUnit

Type: policer:RateUnit
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Rate unit - none, Kilo, Mega, Giga
Constants
unspecified 0 Bits/Packets per second NO COMMENTS
kilo 1 Kilo Bits/Packets per second NO COMMENTS
mega 2 Mega Bits/Packets per second NO COMMENTS
giga 3 Giga Bits/Packets per second NO COMMENTS
DEFAULT unspecified(0) Bits/Packets per second 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.





type

Type: policer:PolicerType
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
nonagg 0 nonagg NO COMMENTS
agg 1 agg NO COMMENTS
DEFAULT nonagg(0) nonagg NO COMMENTS






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail