Class stormctrl:IfPol (CONCRETE)

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

RN FORMAT: stormctrlifp-{name}

    [1] PREFIX=stormctrlifp- PROPERTY = name




DN FORMAT: 

[1] uni/infra/stormctrlifp-{name}

                

Diagram

Super Mo: fabric:L1IfPol, Container Mos: infra:Infra (deletable:yes), Contained Mos: aaa:RbacAnnotation, tag:AInst, tag:Annotation, tag:Tag, Relations From: infra:AccGrp, l1:EthIf, Relations: stormctrl:RtStormctrlIfPol, stormctrl:RtStormctrlIfPolCons,

Containers Hierarchies

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ ctx:Local The local Context.          ├ ctx:Application The context application.            ├ pol:Uni Represents policy definition/resolution universe.              ├ infra:Infra A container for all tenant infra configurations.                ├ stormctrl:IfPol The storm control interface policy. A traffic storm occurs when packets flood the LAN, creating excessive traffic and degrading network performance. You can use the traffic storm control feature to prevent disruptions on ports by a broadcast, multicast, or unknown unicast traffic storm on physical interfaces. top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ pol:Uni Represents policy definition/resolution universe.    ├ infra:Infra A container for all tenant infra configurations.      ├ stormctrl:IfPol The storm control interface policy. A traffic storm occurs when packets flood the LAN, creating excessive traffic and degrading network performance. You can use the traffic storm control feature to prevent disruptions on ports by a broadcast, multicast, or unknown unicast traffic storm on physical interfaces.

Contained Hierarchy

stormctrl:IfPol The storm control interface policy. A traffic storm occurs when packets flood the LAN, creating excessive traffic and degrading network performance. You can use the traffic storm control feature to prevent disruptions on ports by a broadcast, multicast, or unknown unicast traffic storm on physical interfaces.  ├ 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  ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.  ├ health:Inst A base class for a health score instance.(Switch only)  ├ stormctrl:RtStormctrlIfPol   ├ stormctrl:RtStormctrlIfPolCons   ├ tag:AInst The label instance, which is contained by the taggable object.    ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.  ├ tag:Annotation   ├ tag:Tag

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.  ├ pol:Obj Represents a generic policy object.    ├ pol:Def Represents self-contained policy document.      ├ fabric:ProtoPol A base class for protocol policies.        ├ fabric:ProtoIfPol A base class for interface-level protocol policies.          ├ fabric:L1IfPol             ├ stormctrl:IfPol The storm control interface policy. A traffic storm occurs when packets flood the LAN, creating excessive traffic and degrading network performance. You can use the traffic storm control feature to prevent disruptions on ports by a broadcast, multicast, or unknown unicast traffic storm on physical interfaces.

                stormctrl:IfPol:creation__stormctrl_IfPol

                stormctrl:IfPol:modification__stormctrl_IfPol

                stormctrl:IfPol:deletion__stormctrl_IfPol

                

annotation

Type: mo:Annotation
Primitive Type: string:Basic

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

NO COMMENTS

bcBurstPps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Like: l1:StormCtrlP:bcBurstPps
Units: packets
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4882812l

burst rate in pps

bcBurstRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Like: l1:StormCtrlP:bcBurstRate
Units: percentage of bandwidth
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 100

burst rate in % (upto 1 decimal)

bcRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Like: l1:StormCtrlP:bcRate
Units: percentage of bandwidth
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 100

rate in % (upto 1 decimal)

bcRatePps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Like: l1:StormCtrlP:bcRatePps
Units: packets per second
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4882812l

rate in pps

burstPps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Like: l1:StormCtrlP:burstPps
Units: packets
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4882812l

The packets per second (PPS) burst interval rate for the storm control policy. During this interval, the traffic level which is expressed as packets flowing per second through the port, is then compared with the traffic storm control level that you configured. When the ingress traffic reaches the traffic storm control level that is configured on the port, traffic storm control drops the traffic until the interval ends.

burstRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Like: l1:StormCtrlP:burstRate
Units: percentage of bandwidth
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 100

The traffic burst rate percentage.

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

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\\!#$%()*,-./:;@ _{|}~?&+]+

Specifies a description of the policy definition.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

NO COMMENTS

isUcMcBcStormPktCfgValid

Type: l1:StormCtrlCfgValid
Primitive Type: scalar:Enum8

Like: l1:StormCtrlP:isUcMcBcStormPktCfgValid
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

NO COMMENTS

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A value that indicates how this object was created. For internal use only.

mcBurstPps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Like: l1:StormCtrlP:mcBurstPps
Units: packets
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4882812l

burst rate in pps

mcBurstRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Like: l1:StormCtrlP:mcBurstRate
Units: percentage of bandwidth
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 100

burst rate in % (upto 1 decimal)

mcRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Like: l1:StormCtrlP:mcRate
Units: percentage of bandwidth
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 100

rate in % (upto 1 decimal)

mcRatePps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Like: l1:StormCtrlP:mcRatePps
Units: packets per second
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4882812l

rate in pps

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The time when this object was last modified.

monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The monitoring policy attached to this observable object.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

The storm control policy name.

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_.-]+

NO COMMENTS

ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+

The key for enabling clients to own their data for entity correlation.

ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+

A tag for enabling clients to add their own data. For example, to indicate who created this object.

rate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Like: l1:StormCtrlP:rate
Units: percentage of bandwidth
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 100

The traffic rate percentage.

ratePps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Like: l1:StormCtrlP:ratePps
Units: packets per second
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4882812l

The packets per second (PPS) interval rate for the storm control policy. During this interval, the traffic level which is expressed as packets flowing per second through the port, is then compared with the traffic storm control level that you configured. When the ingress traffic reaches the traffic storm control level that is configured on the port, traffic storm control drops the traffic until the interval ends.

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

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

The upgrade status. This property is for internal use only.

stormCtrlAction

Type: l1:StormCtrlActionT
Primitive Type: scalar:Enum8

Like: l1:StormCtrlP:stormCtrlAction
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

action drop/shutdown

stormCtrlSoakInstCount

Type: l1:StormCtrlSoakInstCount
Primitive Type: scalar:Uint16

Like: l1:StormCtrlP:stormCtrlSoakInstCount
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 3  max: 10

Instances required to declare port shutdown

type

Type: l1:PktT
Primitive Type: scalar:Enum8

Like: l1:StormCtrlP:type
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

The storm control interface policy type. The policy type prevents disruptions on ports by a broadcast, multicast, or unknown unicast traffic storm on physical interfaces. The policy type is set to ALL types of traffic by default and can not be changed.

uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A unique identifier for this object.

userdom

Type: mo:UserDomType
Primitive Type: string:Basic

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

NO COMMENTS

uucBurstPps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Like: l1:StormCtrlP:uucBurstPps
Units: packets
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4882812l

burst rate in pps

uucBurstRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Like: l1:StormCtrlP:uucBurstRate
Units: percentage of bandwidth
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 100

burst rate in % (upto 1 decimal)

uucRate

Type: l1:StormCtrlRate
Primitive Type: scalar:Float

Like: l1:StormCtrlP:uucRate
Units: percentage of bandwidth
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 100

rate in % (upto 1 decimal)

uucRatePps

Type: l1:StormCtrlPps
Primitive Type: scalar:Uint32

Like: l1:StormCtrlP:uucRatePps
Units: packets per second
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4882812l

rate in pps