Class ac:RuleMac (CONCRETE)

Class ID:2520
Class Label: Mac 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, ops]
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 ]

Represents media access control (MAC) address-based rules for the atomic counters.

Naming Rules
RN FORMAT: ruleMac-{ruleId}

    [1] PREFIX=ruleMac- PROPERTY = ruleId




DN FORMAT: 

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

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

                


Diagram

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


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:RuleMac Represents media access control (MAC) address-based rules for the atomic counters.
[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:RuleMac Represents media access control (MAC) address-based rules for the atomic counters.


Contained Hierarchy
[V] ac:RuleMac Represents media access control (MAC) address-based rules for the atomic counters.
 ├
[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] 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.


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:RuleMac Represents media access control (MAC) address-based rules for the atomic counters.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: ac:RuleMac
actrl:PcTag
          scalar:Uint32
dPcTag  (ac:RuleMac:dPcTag)
           Specifies destination policy tag.
ac:RuleOperSt
          scalar:Enum8
operState  (ac:RuleMac:operState)
           The operational state of a process.
nw:OSSumQual
          string:Basic
operStateQual  (ac:RuleMac:operStateQual)
           Operational State Qualifier
scalar:Uint64 payload  (ac:RuleMac:payload)
           Holds the payload bytes of MAC-based atomic counter rule.
ac:PayloadSz
          scalar:UByte
payloadSz  (ac:RuleMac:payloadSz)
           Indicates payload size.
scalar:Uint64 ruleId  (ac:RuleMac:ruleId)
           Overrides:ac:Rule:ruleId
           Holds the identifier of MAC-based atomic counter rule.
actrl:PcTag
          scalar:Uint32
sPcTag  (ac:RuleMac:sPcTag)
           Indicates the source policy tag.
ac:EtherT
          scalar:Uint16
type  (ac:RuleMac:type)
           Indicates the ether type.
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 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





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





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.



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



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.



payload

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Holds the payload bytes of MAC-based atomic counter rule.



payloadSz

Type: ac:PayloadSz
Primitive Type: scalar:UByte

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



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 identifier of MAC-based atomic counter rule.



sPcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

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





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





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.






tenantName

Type: naming:Name
Primitive Type: string:Basic

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



type

Type: ac:EtherT
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates the ether type.
Constants
dont-care 0 Wildcard ether type NO COMMENTS
DEFAULT 0 --- Ether type





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.