Class ac:RuleIp (CONCRETE)

Class ID:2519
Class Label: IP Rule
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-connectivity-mgmt, fabric-connectivity-util, fabric-equipment, ops]
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: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

Specifies the IP entry.

Naming Rules
RN FORMAT: ruleIp-{ruleId}

    [1] PREFIX=ruleIp- PROPERTY = ruleId




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ac/ruleIp-{ruleId}

[1] sys/ac/ruleIp-{ruleId}

                


Diagram

Super Mo: ac:Rule,
Container Mos: ac:Entity (deletable:yes),
Contained Mos: ac:Bank, ac:LatencyAvg, ac:LatencyHist,


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] ac:Entity Holds entity information for the atomic counters control plane.
 
 
 
 
 
 ├
[V] ac:RuleIp Specifies the IP entry.
[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] ac:Entity Holds entity information for the atomic counters control plane.
 
 
 ├
[V] ac:RuleIp Specifies the IP entry.


Contained Hierarchy
[V] ac:RuleIp Specifies the IP entry.
 ├
[V] ac:Bank Represents an atomic counter bank. Each atomic counter rule has two sets of banks to count packets and bytes.
 
 ├
[V] ac:EgrHit Represents the number of egress hits
 
 ├
[V] ac:IngrHit Represents the number of ingress hits.
 ├
[V] ac:LatencyAvg Average Latency Data.
 ├
[V] ac:LatencyHist  MO containing histogram data for latency
 ├
[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)


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:Instr Represents a policy control instrumentation object.
 
 
 ├
[V] nw:FltRule A filter rule.
 
 
 
 ├
[V] ac:Rule Represents an ordered set of rules specifing atomic counter policies. Atomic counter policies specify a set of match criteria for counting packets. These policies are used for debugging packet drops inside the fabric. This is an abstract class and cannot be instantiated.
 
 
 
 
 ├
[V] ac:RuleIp Specifies the IP entry.


Events
                


Faults
                ac:RuleIp:latencyOperStFailed
ac:RuleIp:operStFailed


Fsms
                


Properties Summary
Defined in: ac:RuleIp
actrl:PcTag
          scalar:Uint32
dPcTag  (ac:RuleIp:dPcTag)
           Specifies the destination policy tag.
qosp:Dscp
          scalar:UByte
dscp  (ac:RuleIp:dscp)
           Specifies DSCP.
qosp:Dscp
          scalar:UByte
dscpMask  (ac:RuleIp:dscpMask)
           Specifies the DSCP mask.
address:Ip dst  (ac:RuleIp:dst)
           Specifies the IP destination address.
l4:Port
          scalar:Uint16
dstPort  (ac:RuleIp:dstPort)
           Specifies the destination port.
ac:Ecn
          scalar:UByte
ecn  (ac:RuleIp:ecn)
           Specifies the explicit congestion notification (ECN).
ac:Ecn
          scalar:UByte
ecnMask  (ac:RuleIp:ecnMask)
           Specifies the explicit congestion notification (ECN) mask.
ac:IpFlags
          scalar:Bitmask8
flags  (ac:RuleIp:flags)
           Specifies the IP flags.
ac:IpFlags
          scalar:Bitmask8
flagsMask  (ac:RuleIp:flagsMask)
           Specifies the IP flags mask.
icmp:Code
          scalar:Uint16
icmpCode  (ac:RuleIp:icmpCode)
           Specifies the ICMP code.
icmp:Flags
          scalar:UByte
icmpFlags  (ac:RuleIp:icmpFlags)
           Specifies the ICMP flags.
icmp:Type
          scalar:UByte
icmpType  (ac:RuleIp:icmpType)
           Specifies the ICMP type.
scalar:Bool isExt  (ac:RuleIp:isExt)
          
ac:RuleOperSt
          scalar:Enum8
lastOperState  (ac:RuleIp:lastOperState)
          
ac:LatencyCollect
          scalar:Enum8
latencyCollect  (ac:RuleIp:latencyCollect)
           Latency Feature Action
ac:LatencyOperSt
          scalar:Enum8
latencyOperSt  (ac:RuleIp:latencyOperSt)
           Latency Operational State
ac:OperStQual
          string:Basic
latencyOperStQual  (ac:RuleIp:latencyOperStQual)
           Latency Operational State Qualifier
reference:BinRef monPolDn  (ac:RuleIp:monPolDn)
           The monitoring policy attached to this observable object.
ac:RuleOperSt
          scalar:Enum8
operState  (ac:RuleIp:operState)
           The operational state of a process.
nw:OSSumQual
          string:Basic
operStateQual  (ac:RuleIp:operStateQual)
           Operational State Qualifier
ac:IpOpt
          scalar:Bitmask8
options  (ac:RuleIp:options)
           Specifies the IP options.
ac:IpOpt
          scalar:Bitmask8
optionsMask  (ac:RuleIp:optionsMask)
           Specifies the IP options mask.
ac:PayloadSz
          scalar:UByte
payloadSz  (ac:RuleIp:payloadSz)
           Indicates the payload size.
l3:IpProt
          scalar:UByte
prot  (ac:RuleIp:prot)
           Specifies the IP protocol.
scalar:Uint64 ruleId  (ac:RuleIp:ruleId)
           Overrides:ac:Rule:ruleId
           Holds the atomic counter rule identifier for IP packets.
actrl:PcTag
          scalar:Uint32
sPcTag  (ac:RuleIp:sPcTag)
           Specifies the source policy tag.
address:Ip src  (ac:RuleIp:src)
           Holds the source IP address.
l4:Port
          scalar:Uint16
srcPort  (ac:RuleIp:srcPort)
           Specifies the source port.
l4:TcpFlags
          scalar:Bitmask32
tcpFlags  (ac:RuleIp:tcpFlags)
           Indicates TCP flags.
l4:TcpFlags
          scalar:Bitmask32
tcpFlagsMask  (ac:RuleIp:tcpFlagsMask)
           Indicates TCP flags mask
l3:Ttl
          scalar:UByte
ttl  (ac:RuleIp:ttl)
           Specifies time to live (TTL).
ac:IpType
          scalar:Bitmask8
type  (ac:RuleIp:type)
           The specific type of the object or component.
ac:IpRuleUsage
          scalar:Bitmask32
usage  (ac:RuleIp:usage)
           The usage of the port. This property shows how the port is used.
Defined in: ac:Rule
ac:Control
          scalar:Bitmask64
ctrl  (ac:Rule:ctrl)
           Indicates control.
ac:Control
          scalar:Bitmask64
ctrlMask  (ac:Rule:ctrlMask)
           Indicates a wildcard for the control mask when specified in the mask control bit.
qosp:Dot1P
          scalar:UByte
dot1p  (ac:Rule:dot1p)
           Specifies the 802.1p class of service priority level.
qosp:Dot1P
          scalar:UByte
dot1pMask  (ac:Rule:dot1pMask)
           Specifies the wildcard mask to define the range of 802.1p values.
ac:Mac
          address:MAC
dstMac  (ac:Rule:dstMac)
           Specifies the destination MAC address for the rule.
base:Encap fabricEncap  (ac:Rule:fabricEncap)
           Specifies the fabric encapsulation for the rule.
ac:PortId
          base:IfIndex
fabricPort  (ac:Rule:fabricPort)
           Specifies the fabric port for the rule.
ac:Order
          scalar:Uint16
order  (ac:Rule:order)
           Specifies the relative order in which to apply this rule.
reference:BinRef policyDn  (ac:Rule:policyDn)
           A property that indicates if the heartbeat has been delayed on this node.
naming:Name
          string:Basic
policyName  (ac:Rule:policyName)
           The name for the VMM domain policy.
address:Ip remoteTep  (ac:Rule:remoteTep)
           Specifies the remote tunnel endpoint for the rule.
ac:Mac
          address:MAC
srcMac  (ac:Rule:srcMac)
           Specifies the source MAC address for the rule.
naming:Name
          string:Basic
tenantName  (ac:Rule:tenantName)
           The tenant name.
naming:Name
          string:Basic
vrfName  (ac:Rule:vrfName)
           The VRF name. This name can be up to 64 alphanumeric characters.
Defined in: nw:FltRule
naming:Name
          string:Basic
name  (nw:FltRule:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
Defined in: pol:Instr
naming:Descr
          string:Basic
descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
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: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: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





ctrl

Type: ac:Control
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates control.
Constants
snap-encap 1024ull Snap encapsulated Snap encapsulated
local-tep 128ull Local tunnel endpoint local tunnel ep
multi-dest 16ull Multi destination frame multi destination frame
overlay 16ull Overlay tunnelled frame overlay tunnelled frame
routeable 1ull Routeable Routeable
seg-routing 256ull Segment routing segment routing
vxlan 2ull Vxlan encapsulated Vxlan
local-mac 32ull Local mac Local mac
fabric 4ull Is part of fabric fabric
l2-tag 512ull Layer2 tagged l2 tagged or untagged
local-rtrip 64ull Local router ip Local router ip
local-ep 8ull Local endpoint local ep
DEFAULT 0 --- Control





ctrlMask

Type: ac:Control
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates a wildcard for the control mask when specified in the mask control bit.
Constants
snap-encap 1024ull Snap encapsulated Snap encapsulated
local-tep 128ull Local tunnel endpoint local tunnel ep
multi-dest 16ull Multi destination frame multi destination frame
overlay 16ull Overlay tunnelled frame overlay tunnelled frame
routeable 1ull Routeable Routeable
seg-routing 256ull Segment routing segment routing
vxlan 2ull Vxlan encapsulated Vxlan
local-mac 32ull Local mac Local mac
fabric 4ull Is part of fabric fabric
l2-tag 512ull Layer2 tagged l2 tagged or untagged
local-rtrip 64ull Local router ip Local router ip
local-ep 8ull Local endpoint local ep
DEFAULT 0 --- Control





dPcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the destination policy tag.
Constants
any 0u any NO COMMENTS
DEFAULT 0 --- Policy control tag





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.



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.



dot1p

Type: qosp:Dot1P
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the 802.1p class of service priority level.
Constants
0 0 Background Background traffic
1 1 Best Effort Best Effort traffic
2 2 Excellent Effort Excellent Effort traffic
3 3 Critical Applications Critical Applications traffic
4 4 Video, < 100 ms latency and jitter Video traffic
5 5 Voice, < 10 ms latency and jitter Voice traffic
6 6 Internetwork Control Internetwork Control traffic
7 7 Network Control Network Control traffic
unspecified 8 Unspecified Class of traffic not specified, not a real COS value
DEFAULT unspecified(8) Unspecified Class of traffic not specified, not a real COS value





dot1pMask

Type: qosp:Dot1P
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the wildcard mask to define the range of 802.1p values.
Constants
0 0 Background Background traffic
1 1 Best Effort Best Effort traffic
2 2 Excellent Effort Excellent Effort traffic
3 3 Critical Applications Critical Applications traffic
4 4 Video, < 100 ms latency and jitter Video traffic
5 5 Voice, < 10 ms latency and jitter Voice traffic
6 6 Internetwork Control Internetwork Control traffic
7 7 Network Control Network Control traffic
unspecified 8 Unspecified Class of traffic not specified, not a real COS value
DEFAULT unspecified(8) Unspecified Class of traffic not specified, not a real COS value





dscp

Type: qosp:Dscp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies DSCP.
Constants
CS0 0 CS0 CS0
CS1 8 CS1 CS1
AF11 10 AF11 low drop AF11 low drop
AF12 12 AF12 medium drop AF12 medium drop
AF13 14 AF13 high drop AF13 high drop
CS2 16 CS2 CS2
AF21 18 AF21 low drop AF21 low drop
AF22 20 AF22 medium drop AF22 medium drop
AF23 22 AF23 high drop AF22 high drop
CS3 24 CS3 CS3
AF31 26 AF31 low drop AF31 low drop
AF32 28 AF32 medium drop AF32 medium drop
AF33 30 AF33 high drop AF33 high drop
CS4 32 CS4 CS4
AF41 34 AF41 low drop AF41 low drop
AF42 36 AF42 medium drop AF42 medium drop
AF43 38 AF43 high drop AF42 high drop
CS5 40 CS5 CS5
VA 44 Voice Admit VA
EF 46 Expedited Forwarding EF
CS6 48 CS6 CS6
CS7 56 CS7 CS7
unspecified 64 Unspecified Unspecified
DEFAULT unspecified(64) Unspecified Unspecified





dscpMask

Type: qosp:Dscp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the DSCP mask.
Constants
CS0 0 CS0 CS0
CS1 8 CS1 CS1
AF11 10 AF11 low drop AF11 low drop
AF12 12 AF12 medium drop AF12 medium drop
AF13 14 AF13 high drop AF13 high drop
CS2 16 CS2 CS2
AF21 18 AF21 low drop AF21 low drop
AF22 20 AF22 medium drop AF22 medium drop
AF23 22 AF23 high drop AF22 high drop
CS3 24 CS3 CS3
AF31 26 AF31 low drop AF31 low drop
AF32 28 AF32 medium drop AF32 medium drop
AF33 30 AF33 high drop AF33 high drop
CS4 32 CS4 CS4
AF41 34 AF41 low drop AF41 low drop
AF42 36 AF42 medium drop AF42 medium drop
AF43 38 AF43 high drop AF42 high drop
CS5 40 CS5 CS5
VA 44 Voice Admit VA
EF 46 Expedited Forwarding EF
CS6 48 CS6 CS6
CS7 56 CS7 CS7
unspecified 64 Unspecified Unspecified
DEFAULT unspecified(64) Unspecified Unspecified





dst

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the IP destination address.



dstMac

Type: ac:Mac
Primitive Type: address:MAC

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the destination MAC address for the rule.
Constants
dont-care 0ull Wildcard MAC NO COMMENTS
DEFAULT 0 --- MAC





dstPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies the destination 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





ecn

Type: ac:Ecn
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the explicit congestion notification (ECN).
Constants
defaultValue 0 --- NO COMMENTS





ecnMask

Type: ac:Ecn
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the explicit congestion notification (ECN) mask.
Constants
defaultValue 0 --- NO COMMENTS





fabricEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the fabric encapsulation for the rule.



fabricPort

Type: ac:PortId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the fabric port for the rule.



flags

Type: ac:IpFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the IP flags.
Constants
unspecified 0 Unspecified NO COMMENTS
df 1 Do not fragment Dont fragment bit
mf 2 More fragment More fragment bit
frag-offset 4 Fragment offset Fragment offset set
DEFAULT unspecified(0) Unspecified NO COMMENTS





flagsMask

Type: ac:IpFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the IP flags mask.
Constants
unspecified 0 Unspecified NO COMMENTS
df 1 Do not fragment Dont fragment bit
mf 2 More fragment More fragment bit
frag-offset 4 Fragment offset Fragment offset set
DEFAULT unspecified(0) Unspecified NO COMMENTS





icmpCode

Type: icmp:Code
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the ICMP code.
Constants
unspecified 0xffff Unspecified NO COMMENTS
defaultValue 0 --- NO COMMENTS





icmpFlags

Type: icmp:Flags
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the ICMP flags.
Constants
unspecified 255 Unspecified NO COMMENTS
defaultValue 0 --- NO COMMENTS





icmpType

Type: icmp:Type
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the ICMP type.
Constants
unspecified 255 Unspecified NO COMMENTS
defaultValue 0 --- NO COMMENTS





isExt

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





lastOperState

Type: ac:RuleOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Constants
pending 1 Pending Up
installed 2 Installed Down
failed 3 Failed Failed
DEFAULT pending(1) Pending Up





latencyCollect

Type: ac:LatencyCollect
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Latency Feature Action
Constants
avg 1 avg Latency Average
histogram 2 histogram Latency Histogram
DEFAULT avg(1) avg Latency Average





latencyOperSt

Type: ac:LatencyOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Latency Operational State
Constants
pending 1 Pending Up
installed 2 Installed Down
failed 3 Failed Failed
DEFAULT pending(1) Pending Up





latencyOperStQual

Type: ac:OperStQual
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Latency Operational State Qualifier



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: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



operState

Type: ac:RuleOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The operational state of a process.
Constants
pending 1 Pending Up
installed 2 Installed Down
failed 3 Failed Failed
DEFAULT pending(1) Pending Up





operStateQual

Type: nw:OSSumQual
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Operational State Qualifier



options

Type: ac:IpOpt
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the IP options.
Constants
hop-by-hop 1 Hop-by-hop header Hop-by-hop
frag-hdr 2 Fragment header Fragment header
v4-opt 4 IPv4 options v4 options
DEFAULT 0 --- Ip options





optionsMask

Type: ac:IpOpt
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the IP options mask.
Constants
hop-by-hop 1 Hop-by-hop header Hop-by-hop
frag-hdr 2 Fragment header Fragment header
v4-opt 4 IPv4 options v4 options
DEFAULT 0 --- Ip options





order

Type: ac:Order
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the relative order in which to apply this rule.



payloadSz

Type: ac:PayloadSz
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates the payload size.
Constants
dont-care 0xff Wildcard Payload Size NO COMMENTS
DEFAULT 0 --- Payload size





policyDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A property that indicates if the heartbeat has been delayed on this node.



policyName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The name for the VMM domain policy.



prot

Type: l3:IpProt
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies 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





remoteTep

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the remote tunnel endpoint for the rule.



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.



ruleId

Type: scalar:Uint64

Overrides:ac:Rule:ruleId
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
Holds the atomic counter rule identifier for IP packets.



sPcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the source policy tag.
Constants
any 0u any NO COMMENTS
DEFAULT 0 --- Policy control tag





src

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Holds the source IP address.



srcMac

Type: ac:Mac
Primitive Type: address:MAC

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the source MAC address for the rule.
Constants
dont-care 0ull Wildcard MAC NO COMMENTS
DEFAULT 0 --- MAC





srcPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies the 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.






tcpFlags

Type: l4:TcpFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Indicates TCP flags.
Constants
unspecified 0u Unspecified Unspecified
est 16u Established Established - combination of Ack and Reset
syn 1u Synchronize Syn flag
ack 2u Acknowledgment Ack flag
fin 4u Finish Fin flag
rst 8u Reset Reset flag
DEFAULT unspecified(0u) Unspecified Unspecified





tcpFlagsMask

Type: l4:TcpFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Indicates TCP flags mask
Constants
unspecified 0u Unspecified Unspecified
est 16u Established Established - combination of Ack and Reset
syn 1u Synchronize Syn flag
ack 2u Acknowledgment Ack flag
fin 4u Finish Fin flag
rst 8u Reset Reset flag
DEFAULT unspecified(0u) Unspecified Unspecified





tenantName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The tenant name.



ttl

Type: l3:Ttl
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies time to live (TTL).
Constants
unspecified 0 Unspecified Unspecified
DEFAULT unspecified(0) Unspecified Unspecified





type

Type: ac:IpType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
ipv4 1 IPv4 IPv4
ipv6 2 IPv6 IPv6
DEFAULT 0 --- Ip Type





usage

Type: ac:IpRuleUsage
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The usage of the port. This property shows how the port is used.
Constants
atomic-counter 1u Atomic Counter Enable Atomic Counters
latency-stats 2u Latency Statistics Enable Latency Statistics
DEFAULT atomic-counter(1u) Atomic Counter Enable Atomic Counters





vrfName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The VRF name. This name can be up to 64 alphanumeric characters.