Class telemetry:FilterPolicy (CONCRETE)

Class ID:11753
Class Label: Filter Logical Model config holder
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model
Write Access: [admin]
Read Access: [admin]
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 ]

NO COMMENTS

Naming Rules
RN FORMAT: flowflt-{[srcIp]}-{srcPort}-{[dstIp]}-{dstPort}-{protocol}-{action}-{[fvCtxDn]}

    [1] PREFIX=flowflt- PROPERTY = srcIp


    [2] PREFIX=- PROPERTY = srcPort


    [3] PREFIX=- PROPERTY = dstIp


    [4] PREFIX=- PROPERTY = dstPort


    [5] PREFIX=- PROPERTY = protocol


    [6] PREFIX=- PROPERTY = action


    [7] PREFIX=- PROPERTY = fvCtxDn




DN FORMAT: 

[1] uni/fabric/servers/flowserverp-{name}/fltPolGrp-{name}/flowflt-{[srcIp]}-{srcPort}-{[dstIp]}-{dstPort}-{protocol}-{action}-{[fvCtxDn]}

                


Diagram

Super Mo: pol:Obj,
Container Mos: telemetry:FltPolGrp (deletable:yes),
Contained Mos: 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] fabric:Inst A container object for fabric policies.
 
 
 
 
 
 
 
 ├
[V] telemetry:Servers 
 
 
 
 
 
 
 
 
 ├
[V] telemetry:FlowServerP 
 
 
 
 
 
 
 
 
 
 ├
[V] telemetry:FltPolGrp 
 
 
 
 
 
 
 
 
 
 
 ├
[V] telemetry:FilterPolicy 
[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] fabric:Inst A container object for fabric policies.
 
 
 ├
[V] telemetry:Servers 
 
 
 
 ├
[V] telemetry:FlowServerP 
 
 
 
 
 ├
[V] telemetry:FltPolGrp 
 
 
 
 
 
 ├
[V] telemetry:FilterPolicy 


Contained Hierarchy
[V] telemetry:FilterPolicy 
 ├
[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] telemetry:FilterPolicy 


Events
                telemetry:FilterPolicy:creation__telemetry_FilterPolicy
telemetry:FilterPolicy:modification__telemetry_FilterPolicy
telemetry:FilterPolicy:deletion__telemetry_FilterPolicy


Faults
                


Fsms
                


Properties Summary
Defined in: telemetry:FilterPolicy
acl:ActionType
          scalar:Enum8
action  (telemetry:FilterPolicy:action)
           The action required when the condition is met.
mo:Annotation
          string:Basic
annotation  (telemetry:FilterPolicy:annotation)
           NO COMMENTS
address:Ip dstIp  (telemetry:FilterPolicy:dstIp)
           The destination IP address.
acl:PortNumber
          scalar:Uint16
dstPort  (telemetry:FilterPolicy:dstPort)
           The destination port.
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (telemetry:FilterPolicy:extMngdBy)
           NO COMMENTS
reference:BinRef fvCtxDn  (telemetry:FilterPolicy:fvCtxDn)
           fvCtx Dn
telemetry:IPVersion
          scalar:UByte
ipVersion  (telemetry:FilterPolicy:ipVersion)
           IP Version
telemetry:Protocol
          scalar:UByte
protocol  (telemetry:FilterPolicy:protocol)
           The transfer protocol to be used for data export.
address:Ip srcIp  (telemetry:FilterPolicy:srcIp)
           The source IP address. Traffic from this IP address to the EP is counted
acl:PortNumber
          scalar:Uint16
srcPort  (telemetry:FilterPolicy:srcPort)
           The source port.
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: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: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.
Properties Detail

action

Type: acl:ActionType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
The action required when the condition is met.
Constants
invalid 0 invalid NO COMMENTS
permit 1 permit NO COMMENTS
deny 2 deny NO COMMENTS
copy 3 copy NO COMMENTS
divert 4 divert NO COMMENTS
redirect 5 redirect NO COMMENTS
DEFAULT invalid(0) invalid NO COMMENTS





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:
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.



dstIp

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
The destination IP address.



dstPort

Type: acl:PortNumber
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
The destination port.
Constants
echo 7 echo NO COMMENTS
discard 9 discard NO COMMENTS
daytime 13 daytime NO COMMENTS
chargen 19 chargen NO COMMENTS
ftp-data 20 ftp-data NO COMMENTS
ftp 21 ftp NO COMMENTS
telnet 23 telnet NO COMMENTS
smtp 25 smtp NO COMMENTS
time 37 time NO COMMENTS
nameserver 42 nameserver NO COMMENTS
whois 43 whois NO COMMENTS
tacacs 49 tacacs NO COMMENTS
domain 53 domain NO COMMENTS
bootps 67 bootps NO COMMENTS
bootpc 68 bootpc NO COMMENTS
tftp 69 tftp NO COMMENTS
gopher 70 gopher NO COMMENTS
finger 79 finger NO COMMENTS
www 80 www NO COMMENTS
hostname 101 hostname NO COMMENTS
pop2 109 pop2 NO COMMENTS
pop3 110 pop3 NO COMMENTS
sunrpc 111 sunrpc NO COMMENTS
ident 113 ident NO COMMENTS
nntp 119 nntp NO COMMENTS
ntp 123 ntp NO COMMENTS
netbios-ns 137 netbios-ns NO COMMENTS
netbios-dgm 138 netbios-dgm NO COMMENTS
netbios-ss 139 netbios-ss NO COMMENTS
snmp 161 snmp NO COMMENTS
snmptrap 162 snmptrap NO COMMENTS
xdmcp 177 xdmcp NO COMMENTS
bgp 179 bgp NO COMMENTS
irc 194 irc NO COMMENTS
dnsix 195 dnsix NO COMMENTS
mobile-ip 434 mobile-ip NO COMMENTS
pim-auto-rp 496 pim-auto-rp NO COMMENTS
isakmp 500 isakmp NO COMMENTS
biff 512 biff NO COMMENTS
exec 512 exec NO COMMENTS
login 513 login NO COMMENTS
who 513 who NO COMMENTS
cmd 514 cmd NO COMMENTS
syslog 514 syslog NO COMMENTS
lpd 515 lpd NO COMMENTS
talk 517 talk NO COMMENTS
rip 520 rip NO COMMENTS
uucp 540 uucp NO COMMENTS
klogin 543 klogin NO COMMENTS
kshell 544 kshell NO COMMENTS
drip 3949 drip NO COMMENTS
non500-isakmp 4500 non500-isakmp NO COMMENTS
defaultValue 0 --- NO COMMENTS





extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

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





fvCtxDn

Type: reference:BinRef

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



ipVersion

Type: telemetry:IPVersion
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
IP Version
Constants
ipv4 0 ipv4 NO COMMENTS
ipv6 1 ipv6 NO COMMENTS
undefined 2 undefined NO COMMENTS
DEFAULT undefined(2) undefined 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





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



protocol

Type: telemetry:Protocol
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
The transfer protocol to be used for data export.
Constants
hopopt 0 IPv6 hopopt NO COMMENTS
icmp 1 icmp NO COMMENTS
igmp 2 igmp NO COMMENTS
tcp 6 tcp NO COMMENTS
udp 17 udp NO COMMENTS
gre 47 gre NO COMMENTS
esp 50 esp NO COMMENTS
ahp 51 ahp NO COMMENTS
icmp6 58 icmp6 NO COMMENTS
eigrp 88 eigrp NO COMMENTS
ospf 89 ospf NO COMMENTS
nos 94 nos NO COMMENTS
pim 103 pim NO COMMENTS
pcp 108 pcp NO COMMENTS
sctp 132 sctp NO COMMENTS
defaultValue 255 --- 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.



srcIp

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
The source IP address. Traffic from this IP address to the EP is counted



srcPort

Type: acl:PortNumber
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
The source port.
Constants
echo 7 echo NO COMMENTS
discard 9 discard NO COMMENTS
daytime 13 daytime NO COMMENTS
chargen 19 chargen NO COMMENTS
ftp-data 20 ftp-data NO COMMENTS
ftp 21 ftp NO COMMENTS
telnet 23 telnet NO COMMENTS
smtp 25 smtp NO COMMENTS
time 37 time NO COMMENTS
nameserver 42 nameserver NO COMMENTS
whois 43 whois NO COMMENTS
tacacs 49 tacacs NO COMMENTS
domain 53 domain NO COMMENTS
bootps 67 bootps NO COMMENTS
bootpc 68 bootpc NO COMMENTS
tftp 69 tftp NO COMMENTS
gopher 70 gopher NO COMMENTS
finger 79 finger NO COMMENTS
www 80 www NO COMMENTS
hostname 101 hostname NO COMMENTS
pop2 109 pop2 NO COMMENTS
pop3 110 pop3 NO COMMENTS
sunrpc 111 sunrpc NO COMMENTS
ident 113 ident NO COMMENTS
nntp 119 nntp NO COMMENTS
ntp 123 ntp NO COMMENTS
netbios-ns 137 netbios-ns NO COMMENTS
netbios-dgm 138 netbios-dgm NO COMMENTS
netbios-ss 139 netbios-ss NO COMMENTS
snmp 161 snmp NO COMMENTS
snmptrap 162 snmptrap NO COMMENTS
xdmcp 177 xdmcp NO COMMENTS
bgp 179 bgp NO COMMENTS
irc 194 irc NO COMMENTS
dnsix 195 dnsix NO COMMENTS
mobile-ip 434 mobile-ip NO COMMENTS
pim-auto-rp 496 pim-auto-rp NO COMMENTS
isakmp 500 isakmp NO COMMENTS
biff 512 biff NO COMMENTS
exec 512 exec NO COMMENTS
login 513 login NO COMMENTS
who 513 who NO COMMENTS
cmd 514 cmd NO COMMENTS
syslog 514 syslog NO COMMENTS
lpd 515 lpd NO COMMENTS
talk 517 talk NO COMMENTS
rip 520 rip NO COMMENTS
uucp 540 uucp NO COMMENTS
klogin 543 klogin NO COMMENTS
kshell 544 kshell NO COMMENTS
drip 3949 drip NO COMMENTS
non500-isakmp 4500 non500-isakmp NO COMMENTS
defaultValue 0 --- 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.