Class span:FilterEntry (CONCRETE)

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



Naming Rules
RN FORMAT: proto-{ipProto}-src-{[srcAddr]}-dst-{[dstAddr]}-srcPortFrom-{srcPortFrom}-srcPortTo-{srcPortTo}-dstPortFrom-{dstPortFrom}-dstPortTo-{dstPortTo}

    [1] PREFIX=proto- PROPERTY = ipProto


    [2] PREFIX=-src- PROPERTY = srcAddr


    [3] PREFIX=-dst- PROPERTY = dstAddr


    [4] PREFIX=-srcPortFrom- PROPERTY = srcPortFrom


    [5] PREFIX=-srcPortTo- PROPERTY = srcPortTo


    [6] PREFIX=-dstPortFrom- PROPERTY = dstPortFrom


    [7] PREFIX=-dstPortTo- PROPERTY = dstPortTo




DN FORMAT: 

[1] uni/infra/filtergrp-{name}/proto-{ipProto}-src-{[srcAddr]}-dst-{[dstAddr]}-srcPortFrom-{srcPortFrom}-srcPortTo-{srcPortTo}-dstPortFrom-{dstPortFrom}-dstPortTo-{dstPortTo}

                


Diagram

Super Mo: pol:Comp,
Container Mos: span:FilterGrp (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,


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] infra:Infra A container for all tenant infra configurations.
 
 
 
 
 
 
 
 ├
[V] span:FilterGrp Filter Group
 
 
 
 
 
 
 
 
 ├
[V] span:FilterEntry 
[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] infra:Infra A container for all tenant infra configurations.
 
 
 ├
[V] span:FilterGrp Filter Group
 
 
 
 ├
[V] span:FilterEntry 


Contained Hierarchy
[V] span:FilterEntry 
 ├
[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] 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] tag:Annotation 
 ├
[V] tag:Tag 


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:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] span:FilterEntry 


Events
                span:FilterEntry:creation__span_FilterEntry
span:FilterEntry:modification__span_FilterEntry
span:FilterEntry:deletion__span_FilterEntry


Faults
                


Fsms
                


Properties Summary
Defined in: span:FilterEntry
mo:Annotation
          string:Basic
annotation  (span:FilterEntry:annotation)
          
address:Ip dstAddr  (span:FilterEntry:dstAddr)
           Destination IP Prefix
l4:Port
          scalar:Uint16
dstPortFrom  (span:FilterEntry:dstPortFrom)
          
l4:Port
          scalar:Uint16
dstPortTo  (span:FilterEntry:dstPortTo)
          
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (span:FilterEntry:extMngdBy)
          
l3:IpProt
          scalar:UByte
ipProto  (span:FilterEntry:ipProto)
           The IP protocol.
address:Ip srcAddr  (span:FilterEntry:srcAddr)
           Source IP Prefix
l4:Port
          scalar:Uint16
srcPortFrom  (span:FilterEntry:srcPortFrom)
           The First (Starting) Source Port
l4:Port
          scalar:Uint16
srcPortTo  (span:FilterEntry:srcPortTo)
           The Last Source Port
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

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





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 the description of a policy component.



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

Like: span:FltEntry:dstAddr
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
Destination IP Prefix



dstPortFrom

Type: l4:Port
Primitive Type: scalar:Uint16

Like: span:FltEntry:dstPortFrom
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff
    Comments:
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 ftp-data NO COMMENTS
smtp 25 smtp NO COMMENTS
dns 53 dns NO COMMENTS
http 80 http NO COMMENTS
pop3 110 pop3 NO COMMENTS
https 443 https NO COMMENTS
rtsp 554 rtsp NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





dstPortTo

Type: l4:Port
Primitive Type: scalar:Uint16

Like: span:FltEntry:dstPortTo
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff
    Comments:
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 ftp-data NO COMMENTS
smtp 25 smtp NO COMMENTS
dns 53 dns NO COMMENTS
http 80 http NO COMMENTS
pop3 110 pop3 NO COMMENTS
https 443 https NO COMMENTS
rtsp 554 rtsp NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





ipProto

Type: l3:IpProt
Primitive Type: scalar:UByte

Like: span:FltEntry:ipProto
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)255
    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





name

Type: naming:Name
Primitive Type: string:Basic

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



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



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

Like: span:FltEntry:srcAddr
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
Source IP Prefix



srcPortFrom

Type: l4:Port
Primitive Type: scalar:Uint16

Like: span:FltEntry:srcPortFrom
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff
    Comments:
The First (Starting) Source Port
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 ftp-data NO COMMENTS
smtp 25 smtp NO COMMENTS
dns 53 dns NO COMMENTS
http 80 http NO COMMENTS
pop3 110 pop3 NO COMMENTS
https 443 https NO COMMENTS
rtsp 554 rtsp NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





srcPortTo

Type: l4:Port
Primitive Type: scalar:Uint16

Like: span:FltEntry:srcPortTo
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0xffff
    Comments:
The Last Source Port
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 ftp-data NO COMMENTS
smtp 25 smtp NO COMMENTS
dns 53 dns NO COMMENTS
http 80 http NO COMMENTS
pop3 110 pop3 NO COMMENTS
https 443 https NO COMMENTS
rtsp 554 rtsp NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





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.