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 ]

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

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ 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...          ├ ac:Entity Holds entity information for the atomic counters control plane.            ├ ac:RuleIp Specifies the IP entry. top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ 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...    ├ ac:Entity Holds entity information for the atomic counters control plane.      ├ ac:RuleIp Specifies the IP entry.

Contained Hierarchy

ac:RuleIp Specifies the IP entry.  ├ ac:Bank Represents an atomic counter bank. Each atomic counter rule has two sets of banks to count packets and bytes.    ├ ac:EgrHit Represents the number of egress hits    ├ ac:IngrHit Represents the number of ingress hits.  ├ ac:LatencyAvg Average Latency Data.  ├ ac:LatencyHist  MO containing histogram data for latency  ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ 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.  ├ 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.  ├ health:Inst A base class for a health score instance.(Switch only)

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.  ├ pol:Obj Represents a generic policy object.    ├ pol:Instr Represents a policy control instrumentation object.      ├ nw:FltRule A filter rule.        ├ 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.          ├ ac:RuleIp Specifies the IP entry.

                ac:RuleIp:latencyOperStFailed

                ac:RuleIp:operStFailed

                

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

ctrl

Type: ac:Control
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Indicates control.

ctrlMask

Type: ac:Control
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Indicates a wildcard for the control mask when specified in the mask control bit.

dPcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the destination policy tag.

descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Specifies a control instrumentation description.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

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

Specifies the 802.1p class of service priority level.

dot1pMask

Type: qosp:Dot1P
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the wildcard mask to define the range of 802.1p values.

dscp

Type: qosp:Dscp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies DSCP.

dscpMask

Type: qosp:Dscp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the DSCP mask.

dst

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the IP destination address.

dstMac

Type: ac:Mac
Primitive Type: address:MAC

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the destination MAC address for the rule.

dstPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Specifies the destination port.

ecn

Type: ac:Ecn
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the explicit congestion notification (ECN).

ecnMask

Type: ac:Ecn
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the explicit congestion notification (ECN) mask.

fabricEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the fabric encapsulation for the rule.

fabricPort

Type: ac:PortId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the fabric port for the rule.

flags

Type: ac:IpFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the IP flags.

flagsMask

Type: ac:IpFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the IP flags mask.

icmpCode

Type: icmp:Code
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the ICMP code.

icmpFlags

Type: icmp:Flags
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the ICMP flags.

icmpType

Type: icmp:Type
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the ICMP type.

isExt

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

lastOperState

Type: ac:RuleOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

latencyCollect

Type: ac:LatencyCollect
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Latency Feature Action

latencyOperSt

Type: ac:LatencyOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Latency Operational State

latencyOperStQual

Type: ac:OperStQual
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Latency Operational State Qualifier

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A value that indicates how this object was created. For internal use only.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The time when this object was last modified.

monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

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

The name of the object.

nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

NO COMMENTS

operState

Type: ac:RuleOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

The operational state of a process.

operStateQual

Type: nw:OSSumQual
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Operational State Qualifier

options

Type: ac:IpOpt
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the IP options.

optionsMask

Type: ac:IpOpt
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the IP options mask.

order

Type: ac:Order
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

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

Indicates the payload size.

policyDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

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

The name for the VMM domain policy.

prot

Type: l3:IpProt
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the IP protocol.

remoteTep

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the remote tunnel endpoint for the rule.

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

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

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

Specifies the source policy tag.

src

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Holds the source IP address.

srcMac

Type: ac:Mac
Primitive Type: address:MAC

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies the source MAC address for the rule.

srcPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Specifies the source port.

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus

The upgrade status. This property is for internal use only.

tcpFlags

Type: l4:TcpFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Indicates TCP flags.

tcpFlagsMask

Type: l4:TcpFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Indicates TCP flags mask

tenantName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The tenant name.

ttl

Type: l3:Ttl
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies time to live (TTL).

type

Type: ac:IpType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The specific type of the object or component.

usage

Type: ac:IpRuleUsage
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

The usage of the port. This property shows how the port is used.

vrfName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The VRF name. This name can be up to 64 alphanumeric characters.