Class vz:Filter (CONCRETE)

Class ID:1362
Class Label: Filter
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, tenant-security]
Read Access: [admin, nw-svc-device, nw-svc-policy, tenant-connectivity-l2, tenant-connectivity-l3, tenant-security]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

A filter policy is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties.

Naming Rules
RN FORMAT: flt-{name}

    [1] PREFIX=flt- PROPERTY = name




DN FORMAT: 

[1] uni/tn-{name}/flt-{name}

                


Diagram

Super Mo: vz:AFilter,
Container Mos: fv:Tenant (deletable:yes),
Contained Mos: tag:AInst, vz:Entry,
Relations From: fv:ABDPol, vns:AFuncConn, vns:FuncConnInst, fv:Ctx, vz:TSubj, vz:ERFltP, vz:ASTerm, vz:ToEPg, vz:RFltP, vz:Subj, vz:TabooDef, fcpr:RFltPManager, fv:RemotePolHolder, fv:PndgRFltPCont,
Relations To: vns:InTerm, vz:AFilterableUnit,
Relations: vz:RsFiltGraphAtt, vz:RsFwdRFltPAtt, vz:RsRevRFltPAtt, vz:RtBdFloodTo, vz:RtConnToFlt, vz:RtConnToFltInst, vz:RtCtxMcastTo, vz:RtDenyRule, vz:RtERFltPOwner, vz:RtFiltAtt, vz:RtFwdRFltPAtt, vz:RtRFltAtt, vz:RtRFltPOwner, vz:RtRevRFltPAtt, vz:RtSubjFiltAtt, vz:RtTabooRFltAtt, vz:RtTnDenyRule, vz:RtToRFltP, vz:RtToRemoteRFltAtt, vz:RtToRemoteRFltP,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] vz:Filter A filter policy is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] vz:Filter A filter policy is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties.


Contained Hierarchy
[V] vz:Filter A filter policy is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties.
 ├
[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: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.
 ├
[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)
 ├
[V] tag:AInst The label instance, which is contained by the taggable object.
 
 ├
[V] 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.
 ├
[V] vz:Entry A filter entry is a combination of network traffic classification properties.
 
 ├
[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: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.
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] tag:AInst The label instance, which is contained by the taggable object.
 
 
 ├
[V] 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.
 ├
[V] vz:RsFiltGraphAtt A source relation to an input terminal node. For abstract graphs, this is the terminal node at the input end. Note that this relation is an internal object.
 
 ├
[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)
 
 ├
[V] tag:AInst The label instance, which is contained by the taggable object.
 
 
 ├
[V] 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.
 ├
[V] vz:RsFwdRFltPAtt A source relation to forward a resolved filter profile. Note that this relation is an internal object.
 ├
[V] vz:RsRevRFltPAtt The reverse resolved filter profile.
 ├
[V] vz:RtBdFloodTo A target relation to a filter. A filter is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties. Note that this relation is an internal object.
 ├
[V] vz:RtConnToFlt A target relation to an abstraction of a filter object, which can be a filter, folder of filters , or a collection of filters. Note that this relation is an internal object.
 ├
[V] vz:RtConnToFltInst A target relation to an abstraction of a filter object, which can be a filter, folder of filters , or a collection of filters. Note that this relation is an internal object.
 ├
[V] vz:RtCtxMcastTo A target relation to a filter. A filter is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties. Note that this relation is an internal object.
 ├
[V] vz:RtDenyRule A target relation to a filter. A filter is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties. Note that this relation is an internal object.
 ├
[V] vz:RtERFltPOwner 
 ├
[V] vz:RtFiltAtt A target relation to a filter. A filter is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties. Note that this relation is an internal object.
 ├
[V] vz:RtFwdRFltPAtt A target relation to a forward remote filter profile.
 ├
[V] vz:RtRFltAtt A target relation to a resolved filter profile.
 ├
[V] vz:RtRFltPOwner A target relation to a filter. A filter is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties. Note that this relation is an internal object.
 ├
[V] vz:RtRevRFltPAtt The reverse a resolved filter profile.
 ├
[V] vz:RtSubjFiltAtt A target relation to a filter. A filter is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties. Note that this relation is an internal object.
 ├
[V] vz:RtTabooRFltAtt A target relation to a taboo resolved filter profile.
 ├
[V] vz:RtTnDenyRule A target relation to a filter. A filter is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties. Note that this relation is an internal object.
 ├
[V] vz:RtToRFltP 
 ├
[V] vz:RtToRemoteRFltAtt A target relation to remote resolved filter profile.
 ├
[V] vz:RtToRemoteRFltP 


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:Def Represents self-contained policy document.
 
 
 ├
[V] vz:AFilterable An abstraction of a filter object. The filter object is a filter.
 
 
 
 ├
[V] vz:AFilterableUnit An abstraction of a filterable unit.
 
 
 
 
 ├
[V] vz:AFilter An abstraction of a filter. A filter is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties. Note that this relation is an internal object.
 
 
 
 
 
 ├
[V] vz:Filter A filter policy is a group of resolvable filter entries. Each filter entry is a combination of network traffic classification properties.


Events
                vz:Filter:creation__vz_Filter
vz:Filter:modification__vz_Filter
vz:Filter:deletion__vz_Filter


Faults
                


Fsms
                


Properties Summary
Defined in: vz:Filter
actrl:FltId
          scalar:Uint32
fwdId  (vz:Filter:fwdId)
          
reference:BinRef monPolDn  (vz:Filter:monPolDn)
          
naming:Name
          string:Basic
name  (vz:Filter:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of a filter policy. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved.
actrl:FltId
          scalar:Uint32
revId  (vz:Filter:revId)
          
scalar:Uint64 txId  (vz:Filter:txId)
           Indicates the identifier of the transaction in which the user action occurred.
scalar:Bool usesIds  (vz:Filter:usesIds)
          
Defined in: vz:AFilter
vz:FltId
          scalar:Uint16
id  (vz:AFilter:id)
           Id
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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:Taggable
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (mo:Taggable:extMngdBy)
           True is Mo is managed by external orchestrators.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

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





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\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
True is Mo is managed by external orchestrators.
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





fwdId

Type: actrl:FltId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
implarp 0xfffdu Implicit filter id for arp NO COMMENTS
implicit 0xfffeu Implicit filter id for internal consumption NO COMMENTS
default 0xffffu Default filter id This is the default filter id, representing a wildcard
defaultValue 0u --- NO COMMENTS





id

Type: vz:FltId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Id
Constants
implicit 0xfffe Implicit filter id for internal consumption NO COMMENTS
default 0xffff Default filter id This is the default filter id, representing a wildcard
DEFAULT 0 --- 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





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:



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_.:-]+
    Comments:
The name of a filter policy. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved.



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_.-]+
    Comments:
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\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
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\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



revId

Type: actrl:FltId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
implarp 0xfffdu Implicit filter id for arp NO COMMENTS
implicit 0xfffeu Implicit filter id for internal consumption NO COMMENTS
default 0xffffu Default filter id This is the default filter id, representing a wildcard
defaultValue 0u --- 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.






txId

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates the identifier of the transaction in which the user action occurred.



uid

Type: scalar:Uint16

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



usesIds

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS