Class copp:Filter (CONCRETE)

Class ID:10159
Class Label: Filter entry
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: 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 ]

Filter

Naming Rules
RN FORMAT: filter-{[name]}

    [1] PREFIX=filter- PROPERTY = name




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/copp/rulep-{[name]}-{type}/filter-{[name]}

[1] sys/copp/rulep-{[name]}-{type}/filter-{[name]}

                


Diagram

Container Mos: copp:Rule (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] copp:Entity Represents control plane entity information.
 
 
 
 
 
 ├
[V] copp:Rule  Holder for copp class policy, each class describes a set of rules describing the policer rates
 
 
 
 
 
 
 ├
[V] copp:Filter  Filter
[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] copp:Entity Represents control plane entity information.
 
 
 ├
[V] copp:Rule  Holder for copp class policy, each class describes a set of rules describing the policer rates
 
 
 
 ├
[V] copp:Filter  Filter


Contained Hierarchy
[V] copp:Filter  Filter
 ├
[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] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] copp:Filter  Filter


Stat Counters
scalar:Double GAUGE: copp:FilterStats:bytesRate(bytes-per-second)
           Bytes rate
          Comments: NO COMMENTS
scalar:Uint64 COUNTER: copp:FilterStats:bytes(bytes)
           Bytes
          Comments: bytes
scalar:Double GAUGE: copp:FilterStats:pktsRate(packets-per-second)
           Packets rate
          Comments: NO COMMENTS
scalar:Uint64 COUNTER: copp:FilterStats:pkts(packets)
           Packets
          Comments: packets


Stats
[V] copp:Filter  Filter
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] 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.
 ├
[V] copp:FilterStatsHist15min A class that represents historical statistics for Filter Match Counters in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] copp:FilterStatsHist1d A class that represents historical statistics for Filter Match Counters in a 1 day sampling interval. This class updates every hour.
 ├
[V] copp:FilterStatsHist1h A class that represents historical statistics for Filter Match Counters in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] copp:FilterStatsHist1mo A class that represents historical statistics for Filter Match Counters in a 1 month sampling interval. This class updates every day.
 ├
[V] copp:FilterStatsHist1qtr A class that represents historical statistics for Filter Match Counters in a 1 quarter sampling interval. This class updates every day.
 ├
[V] copp:FilterStatsHist1w A class that represents historical statistics for Filter Match Counters in a 1 week sampling interval. This class updates every day.
 ├
[V] copp:FilterStatsHist1year A class that represents historical statistics for Filter Match Counters in a 1 year sampling interval. This class updates every day.
 ├
[V] copp:FilterStatsHist5min A class that represents historical statistics for Filter Match Counters in a 5 minute sampling interval. This class updates every 10 seconds.


Events
                copp:Filter:creation__copp_Filter
copp:Filter:modification__copp_Filter
copp:Filter:deletion__copp_Filter


Faults
                


Fsms
                


Properties Summary
Defined in: copp:Filter
copp:ActionType
          scalar:Uint16
action  (copp:Filter:action)
           The action required when the condition is met.
address:Ip dstAddr  (copp:Filter:dstAddr)
           Destination IP
scalar:Uint32 dstPortFrom  (copp:Filter:dstPortFrom)
           Destination Port From
scalar:Uint32 dstPortTo  (copp:Filter:dstPortTo)
           Destination Port To
l3:IpProt
          scalar:UByte
ipProto  (copp:Filter:ipProto)
           The IP protocol.
reference:BinRef monPolDn  (copp:Filter:monPolDn)
           The monitoring policy attached to this observable object.
copp:FilterName
          string:Basic
name  (copp:Filter:name)
           The name of the object.
copp:CoppOperSt
          scalar:Bitmask16
operSt  (copp:Filter:operSt)
           The runtime state of the object or policy.
copp:FilterOperStQual
          scalar:Enum8
operStQual  (copp:Filter:operStQual)
           The chassis operational status qualifier.
copp:FilterPrio
          scalar:Uint16
prio  (copp:Filter:prio)
           The QoS priority class ID.
scalar:Bitmask64 qosmCfgFailedBmp  (copp:Filter:qosmCfgFailedBmp)
           A bitmap of configuration attributes that failed to be applied.
scalar:Time qosmCfgFailedTs  (copp:Filter:qosmCfgFailedTs)
           The timestamp of the last failed configuration.
scalar:UByte qosmCfgState  (copp:Filter:qosmCfgState)
           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.
address:Ip srcAddr  (copp:Filter:srcAddr)
           Source IP
scalar:Uint32 srcPortFrom  (copp:Filter:srcPortFrom)
           Source Port From
scalar:Uint32 srcPortTo  (copp:Filter:srcPortTo)
           Source Port To
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.
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

action

Type: copp:ActionType
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The action required when the condition is met.
Constants
permit 0 permit NO COMMENTS
deny 1 deny NO COMMENTS
DEFAULT permit(0) permit 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.



dstAddr

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Destination IP



dstPortFrom

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Destination Port From



dstPortTo

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Destination Port To



ipProto

Type: l3:IpProt
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IP protocol.
Constants
unspecified 0 Unspecified Unspecified
icmp 1 icmp NO COMMENTS
igmp 2 igmp NO COMMENTS
tcp 6 tcp NO COMMENTS
egp 8 egp NO COMMENTS
igp 9 igp NO COMMENTS
udp 17 udp NO COMMENTS
icmpv6 58 icmpv6 NO COMMENTS
eigrp 88 eigrp NO COMMENTS
ospfigp 89 ospf NO COMMENTS
pim 103 pim NO COMMENTS
l2tp 115 l2tp NO COMMENTS
DEFAULT unspecified(0) Unspecified Unspecified





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





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.



name

Type: copp:FilterName
Primitive Type: string:Basic

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "512"
    Comments:
The name of the object.



operSt

Type: copp:CoppOperSt
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
The runtime state of the object or policy.
Constants
up 1 Up NO COMMENTS
down 2 Down NO COMMENTS
DEFAULT 0 --- Filter operational state





operStQual

Type: copp:FilterOperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
The chassis operational status qualifier.
Constants
none 0 None NO COMMENTS
tcam-unavailable 1 TCAM unavailable NO COMMENTS
policer-unavailable 2 Policer unavailable NO COMMENTS
hardware-err 3 Hardware error NO COMMENTS
DEFAULT none(0) None NO COMMENTS





prio

Type: copp:FilterPrio
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The QoS priority class ID.
Constants
defaultValue 65535 --- NO COMMENTS





qosmCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
A bitmap of configuration attributes that failed to be applied.
Constants
copp:FilterlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
copp:FiltersrcPortFrom_failed_flag 16384ull --- NO COMMENTS
copp:FilteripProto_failed_flag 16ull --- NO COMMENTS
copp:Filteraction_failed_flag 1ull --- NO COMMENTS
copp:FiltermodTs_failed_flag 2305843009213693952ull --- NO COMMENTS
copp:FilterdstAddr_failed_flag 2ull --- NO COMMENTS
copp:FiltersrcPortTo_failed_flag 32768ull --- NO COMMENTS
copp:FiltermonPolDn_failed_flag 32ull --- NO COMMENTS
copp:Filteruid_failed_flag 4611686018427387904ull --- NO COMMENTS
copp:FilterdstPortFrom_failed_flag 4ull --- NO COMMENTS
copp:Filterprio_failed_flag 512ull --- NO COMMENTS
copp:Filtername_failed_flag 64ull --- NO COMMENTS
copp:FiltersrcAddr_failed_flag 8192ull --- NO COMMENTS
copp:FilterdstPortTo_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





qosmCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
The timestamp of the last failed configuration.



qosmCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
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
    Comments:
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
Access: implicit
Category: TopLevelRegular
    Comments:
Source IP



srcPortFrom

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Source Port From



srcPortTo

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Source Port To



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.






uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.