Class l1:StormCtrlP (CONCRETE)

Class ID:5612
Class Label: Storm Control Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l1, admin]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: Infra, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]



Naming Rules
RN FORMAT: stormctrlp

    [1] PREFIX=stormctrlp


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/aggr-{[id]}/stormctrlp

[1] sys/aggr-{[id]}/stormctrlp

[2] topology/pod-{id}/node-{id}/sys/phys-{[id]}/stormctrlp

[3] sys/phys-{[id]}/stormctrlp

                


Diagram

Container Mos: l1:PhysIf (deletable:yes), pc:AggrIf (deletable:yes),


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] pc:AggrIf The aggregated interface, which is a collection of physical ports; aka port channel
 
 
 
 
 
 ├
[V] l1:StormCtrlP 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] pc:AggrIf The aggregated interface, which is a collection of physical ports; aka port channel
 
 
 ├
[V] l1:StormCtrlP 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] l1:PhysIf The object that represents the Layer 1 physical Ethernet interface information object.
 
 
 
 
 
 ├
[V] l1:StormCtrlP 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] l1:PhysIf The object that represents the Layer 1 physical Ethernet interface information object.
 
 
 ├
[V] l1:StormCtrlP 


Contained Hierarchy
[V] l1:StormCtrlP 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] l1:StormCtrlP 


Events
                


Faults
                l1:StormCtrlP:StormActionSoakInstCfgIsNotSupported
l1:StormCtrlP:UcMcBcStormPktCfgIsNotSupported


Fsms
                


Properties Summary
Defined in: l1:StormCtrlP
l1:StormCtrlPps
          scalar:Uint32
bcBurstPps  (l1:StormCtrlP:bcBurstPps)
           Max Burst Rate Allowed in PPS
l1:StormCtrlRate
          scalar:Float
bcBurstRate  (l1:StormCtrlP:bcBurstRate)
           Max Burst Rate Allowed
l1:StormCtrlRate
          scalar:Float
bcRate  (l1:StormCtrlP:bcRate)
           Max Rate Allowed
l1:StormCtrlPps
          scalar:Uint32
bcRatePps  (l1:StormCtrlP:bcRatePps)
           Max Rate Allowed in PPS
l1:StormCtrlPps
          scalar:Uint32
burstPps  (l1:StormCtrlP:burstPps)
          
l1:StormCtrlRate
          scalar:Float
burstRate  (l1:StormCtrlP:burstRate)
          
l1:IsStormCtrlActionSoakInstCfgSupported
          scalar:Enum8
isStormActionSoakInstCfgSupported  (l1:StormCtrlP:isStormActionSoakInstCfgSupported)
           NO COMMENTS
l1:IsStormCtrlCfgSupported
          scalar:Enum8
isUcMcBcStormPktCfgSupported  (l1:StormCtrlP:isUcMcBcStormPktCfgSupported)
           NO COMMENTS
l1:StormCtrlCfgValid
          scalar:Enum8
isUcMcBcStormPktCfgValid  (l1:StormCtrlP:isUcMcBcStormPktCfgValid)
           NO COMMENTS
l1:StormCtrlPps
          scalar:Uint32
mcBurstPps  (l1:StormCtrlP:mcBurstPps)
           Max Burst Rate Allowed in PPS
l1:StormCtrlRate
          scalar:Float
mcBurstRate  (l1:StormCtrlP:mcBurstRate)
           Max Burst Rate Allowed
l1:StormCtrlRate
          scalar:Float
mcRate  (l1:StormCtrlP:mcRate)
           Max Rate Allowed
l1:StormCtrlPps
          scalar:Uint32
mcRatePps  (l1:StormCtrlP:mcRatePps)
           Max Rate Allowed in PPS
reference:BinRef monPolDn  (l1:StormCtrlP:monPolDn)
           The monitoring policy attached to this observable object.
l1:StormCtrlRate
          scalar:Float
rate  (l1:StormCtrlP:rate)
           An allowed rate. This is the committed rate at which the packets are allowed into the system (raw NTPD format).
l1:StormCtrlPps
          scalar:Uint32
ratePps  (l1:StormCtrlP:ratePps)
          
l1:StormCtrlActionT
          scalar:Enum8
stormCtrlAction  (l1:StormCtrlP:stormCtrlAction)
           Storm Control Policy Enhancement start Action - drop/shutdown interface
l1:StormCtrlSoakInstCount
          scalar:Uint16
stormCtrlSoakInstCount  (l1:StormCtrlP:stormCtrlSoakInstCount)
           Action - drop/shutdown interface
l1:PktT
          scalar:Enum8
type  (l1:StormCtrlP:type)
           The specific type of the object or component.
l1:StormCtrlPps
          scalar:Uint32
uucBurstPps  (l1:StormCtrlP:uucBurstPps)
           Max Burst Rate Allowed in PPS
l1:StormCtrlRate
          scalar:Float
uucBurstRate  (l1:StormCtrlP:uucBurstRate)
           Max Burst Rate Allowed
l1:StormCtrlRate
          scalar:Float
uucRate  (l1:StormCtrlP:uucRate)
           Max Rate Allowed
l1:StormCtrlPps
          scalar:Uint32
uucRatePps  (l1:StormCtrlP:uucRatePps)
           Max Rate Allowed in PPS
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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.
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Properties Detail

bcBurstPps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Units: packets
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Burst Rate Allowed in PPS
Constants
unspecified 0xffffffffu Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffu) Unspecified NO COMMENTS





bcBurstRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Units: percentage of bandwidth
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Burst Rate Allowed
Constants
defaultValue 100 --- NO COMMENTS





bcRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Units: percentage of bandwidth
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Rate Allowed
Constants
defaultValue 100 --- NO COMMENTS





bcRatePps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Units: packets per second
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Rate Allowed in PPS
Constants
unspecified 0xffffffffu Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffu) Unspecified NO COMMENTS





burstPps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Units: packets
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
unspecified 0xffffffffu Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffu) Unspecified NO COMMENTS





burstRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Units: percentage of bandwidth
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
defaultValue 100 --- 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





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.



isStormActionSoakInstCfgSupported

Type: l1:IsStormCtrlActionSoakInstCfgSupported
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
Supported 0 Hardware supports Storm Control Action and Soak-instance-count config NO COMMENTS
Unsupported 1 Hardware does not support Storm Control Action and Soak-instance-count config NO COMMENTS
DEFAULT Supported(0) Hardware supports Storm Control Action and Soak-instance-count config NO COMMENTS





isUcMcBcStormPktCfgSupported

Type: l1:IsStormCtrlCfgSupported
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
Supported 0 Hardware supports granular Storm Control config NO COMMENTS
Unsupported 1 Hardware does not support granular Storm Control config NO COMMENTS
DEFAULT Supported(0) Hardware supports granular Storm Control config NO COMMENTS





isUcMcBcStormPktCfgValid

Type: l1:StormCtrlCfgValid
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
Invalid 0 All Types NO COMMENTS
Valid 1 Unicast, Broadcast, Multicast NO COMMENTS
DEFAULT Invalid(0) All Types NO COMMENTS





lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





mcBurstPps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Units: packets
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Burst Rate Allowed in PPS
Constants
unspecified 0xffffffffu Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffu) Unspecified NO COMMENTS





mcBurstRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Units: percentage of bandwidth
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Burst Rate Allowed
Constants
defaultValue 100 --- NO COMMENTS





mcRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Units: percentage of bandwidth
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Rate Allowed
Constants
defaultValue 100 --- NO COMMENTS





mcRatePps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Units: packets per second
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Rate Allowed in PPS
Constants
unspecified 0xffffffffu Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffu) Unspecified NO COMMENTS





modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



rate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Units: percentage of bandwidth
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).
Constants
defaultValue 100 --- NO COMMENTS





ratePps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Units: packets per second
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
unspecified 0xffffffffu Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffu) Unspecified 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.






stormCtrlAction

Type: l1:StormCtrlActionT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Storm Control Policy Enhancement start Action - drop/shutdown interface
Constants
drop 0 drop NO COMMENTS
shutdown 1 shutdown NO COMMENTS
DEFAULT drop(0) drop NO COMMENTS





stormCtrlSoakInstCount

Type: l1:StormCtrlSoakInstCount
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Action - drop/shutdown interface
Constants
defaultValue 3 --- NO COMMENTS





type

Type: l1:PktT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
bcast 1 bcast NO COMMENTS
unk-ucast 2 unk-ucast NO COMMENTS
mcast 3 mcast NO COMMENTS
all 4 all NO COMMENTS
DEFAULT all(4) all NO COMMENTS





uucBurstPps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Units: packets
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Burst Rate Allowed in PPS
Constants
unspecified 0xffffffffu Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffu) Unspecified NO COMMENTS





uucBurstRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Units: percentage of bandwidth
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Burst Rate Allowed
Constants
defaultValue 100 --- NO COMMENTS





uucRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Units: percentage of bandwidth
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Rate Allowed
Constants
defaultValue 100 --- NO COMMENTS





uucRatePps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Units: packets per second
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Rate Allowed in PPS
Constants
unspecified 0xffffffffu Unspecified NO COMMENTS
DEFAULT unspecified(0xffffffffu) Unspecified NO COMMENTS