Class copp:Filter (CONCRETE)

Class ID:10159
Class Label: Filter entry
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [access-qos, admin]
Read Access: [access-qos, 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: true, HasFaults: true, HasHealth: true, HasEventRules: false ]

RN FORMAT: filter-{action}-prio-{prio}-proto-{ipProto}-src-{[srcAddr]}-dst-{[dstAddr]}-srcFromP-{srcPortFrom}-srcToP-{srcPortTo}-dstFromP-{dstPortFrom}-dstToP-{dstPortTo}

    [1] PREFIX=filter- PROPERTY = action


    [2] PREFIX=-prio- PROPERTY = prio


    [3] PREFIX=-proto- PROPERTY = ipProto


    [4] PREFIX=-src- PROPERTY = srcAddr


    [5] PREFIX=-dst- PROPERTY = dstAddr


    [6] PREFIX=-srcFromP- PROPERTY = srcPortFrom


    [7] PREFIX=-srcToP- PROPERTY = srcPortTo


    [8] PREFIX=-dstFromP- PROPERTY = dstPortFrom


    [9] PREFIX=-dstToP- PROPERTY = dstPortTo




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/copp/rulep-{[name]}-{type}/filter-{action}-prio-{prio}-proto-{ipProto}-src-{[srcAddr]}-dst-{[dstAddr]}-srcFromP-{srcPortFrom}-srcToP-{srcPortTo}-dstFromP-{dstPortFrom}-dstToP-{dstPortTo}

[1] sys/copp/rulep-{[name]}-{type}/filter-{action}-prio-{prio}-proto-{ipProto}-src-{[srcAddr]}-dst-{[dstAddr]}-srcFromP-{srcPortFrom}-srcToP-{srcPortTo}-dstFromP-{dstPortFrom}-dstToP-{dstPortTo}

                

Diagram

Container Mos: copp:Rule (deletable:yes), Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,

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.        ├ 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...          ├ copp:Entity Represents control plane entity information.            ├ copp:Rule  Holder for copp class policy, each class describes a set of rules describing the policer rates              ├ copp:Filter  Filter top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ 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...    ├ copp:Entity Represents control plane entity information.      ├ copp:Rule  Holder for copp class policy, each class describes a set of rules describing the policer rates        ├ copp:Filter  Filter

Contained Hierarchy

copp:Filter  Filter  ├ 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: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.    ├ 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    ├ tag:Annotation     ├ tag:Tag   ├ health:Inst A base class for a health score instance.(Switch only)  ├ tag:Annotation   ├ tag:Tag

Inheritance

copp:Filter  Filter

Stats

copp:Filter  Filter  ├ copp:FilterStats15min A class that represents the most current statistics for Filter Match Counters in a 15 minute sampling interval. This class updates every 5 minutes.  ├ copp:FilterStats1d A class that represents the most current statistics for Filter Match Counters in a 1 day sampling interval. This class updates every hour.  ├ copp:FilterStats1h A class that represents the most current statistics for Filter Match Counters in a 1 hour sampling interval. This class updates every 15 minutes.  ├ copp:FilterStats1mo A class that represents the most current statistics for Filter Match Counters in a 1 month sampling interval. This class updates every day.  ├ copp:FilterStats1qtr A class that represents the most current statistics for Filter Match Counters in a 1 quarter sampling interval. This class updates every day.  ├ copp:FilterStats1w A class that represents the most current statistics for Filter Match Counters in a 1 week sampling interval. This class updates every day.  ├ copp:FilterStats1year A class that represents the most current statistics for Filter Match Counters in a 1 year sampling interval. This class updates every day.  ├ copp:FilterStats5min A class that represents the most current statistics for Filter Match Counters in a 5 minute sampling interval. This class updates every 10 seconds.  ├ copp:FilterStatsHist15min A class that represents historical statistics for Filter Match Counters in a 15 minute sampling interval. This class updates every 5 minutes.  ├ copp:FilterStatsHist1d A class that represents historical statistics for Filter Match Counters in a 1 day sampling interval. This class updates every hour.  ├ copp:FilterStatsHist1h A class that represents historical statistics for Filter Match Counters in a 1 hour sampling interval. This class updates every 15 minutes.  ├ copp:FilterStatsHist1mo A class that represents historical statistics for Filter Match Counters in a 1 month sampling interval. This class updates every day.  ├ copp:FilterStatsHist1qtr A class that represents historical statistics for Filter Match Counters in a 1 quarter sampling interval. This class updates every day.  ├ copp:FilterStatsHist1w A class that represents historical statistics for Filter Match Counters in a 1 week sampling interval. This class updates every day.  ├ copp:FilterStatsHist1year A class that represents historical statistics for Filter Match Counters in a 1 year sampling interval. This class updates every day.  ├ copp:FilterStatsHist5min A class that represents historical statistics for Filter Match Counters in a 5 minute sampling interval. This class updates every 10 seconds.  ├ copp:Permit15min A class that represents the most current statistics for Filter Counters in a 15 minute sampling interval. This class updates every 5 minutes.  ├ copp:Permit1d A class that represents the most current statistics for Filter Counters in a 1 day sampling interval. This class updates every hour.  ├ copp:Permit1h A class that represents the most current statistics for Filter Counters in a 1 hour sampling interval. This class updates every 15 minutes.  ├ copp:Permit1mo A class that represents the most current statistics for Filter Counters in a 1 month sampling interval. This class updates every day.  ├ copp:Permit1qtr A class that represents the most current statistics for Filter Counters in a 1 quarter sampling interval. This class updates every day.  ├ copp:Permit1w A class that represents the most current statistics for Filter Counters in a 1 week sampling interval. This class updates every day.  ├ copp:Permit1year A class that represents the most current statistics for Filter Counters in a 1 year sampling interval. This class updates every day.  ├ copp:Permit5min A class that represents the most current statistics for Filter Counters in a 5 minute sampling interval. This class updates every 10 seconds.  ├ copp:PermitHist15min A class that represents historical statistics for Filter Counters in a 15 minute sampling interval. This class updates every 5 minutes.  ├ copp:PermitHist1d A class that represents historical statistics for Filter Counters in a 1 day sampling interval. This class updates every hour.  ├ copp:PermitHist1h A class that represents historical statistics for Filter Counters in a 1 hour sampling interval. This class updates every 15 minutes.  ├ copp:PermitHist1mo A class that represents historical statistics for Filter Counters in a 1 month sampling interval. This class updates every day.  ├ copp:PermitHist1qtr A class that represents historical statistics for Filter Counters in a 1 quarter sampling interval. This class updates every day.  ├ copp:PermitHist1w A class that represents historical statistics for Filter Counters in a 1 week sampling interval. This class updates every day.  ├ copp:PermitHist1year A class that represents historical statistics for Filter Counters in a 1 year sampling interval. This class updates every day.  ├ copp:PermitHist5min A class that represents historical statistics for Filter Counters in a 5 minute sampling interval. This class updates every 10 seconds.

                copp:Filter:creation__copp_Filter

                copp:Filter:modification__copp_Filter

                copp:Filter:deletion__copp_Filter

                

                copp:Filter:prefilterHardwareError

                copp:Filter:prefilterHwUnsupported

                copp:Filter:prefilterInvalidConfig

                copp:Filter:prefilterTcamUnvailable

                

action

Type: copp:ActionType
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

The action required when the condition is met.

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

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

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

Delete or ignore. For internal use only.

createdBy

Type: reference:BinRef

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

A Filter is created as a consequence of a configuration from an MO, this is the DN of that MO triggering this filter to be created.

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.

dstAddr

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Destination IP

dstPortFrom

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff

Destination Port From

dstPortTo

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff

Destination Port To

extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

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

NO COMMENTS

ipProto

Type: l3:IpProt
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)255

The IP protocol.

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.

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.

operSt

Type: copp:CoppOperSt
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

The runtime state of the object or policy.

operStQual

Type: copp:FilterOperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

The chassis operational status qualifier.

prio

Type: copp:FilterPrio
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 65535

The QoS priority class ID.

qosmCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

A bitmap of configuration attributes that failed to be applied.

qosmCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

The timestamp of the last failed configuration.

qosmCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

The status of a configuration. This property specifies if the rules have been programmed. If the value is set to 1, PE will retry after every 30 seconds.

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.

srcAddr

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Source IP

srcPortFrom

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff

Source Port From

srcPortTo

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff

Source Port To

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.

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