Class actrl:Rule (CONCRETE)

Class ID:2481
Class Label: Rule
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-security]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Explicit
Monitoring Policy Source: Explicit
Monitoring Flags : [ IsObservable: true, HasStats: true, HasFaults: true, HasHealth: true, HasEventRules: false ]

RN FORMAT: rule-{scopeId}-s-{sPcTag}-d-{dPcTag}-f-{fltId}

    [1] PREFIX=rule- PROPERTY = scopeId


    [2] PREFIX=-s- PROPERTY = sPcTag


    [3] PREFIX=-d- PROPERTY = dPcTag


    [4] PREFIX=-f- PROPERTY = fltId




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/actrl/scope-{id}/rule-{scopeId}-s-{sPcTag}-d-{dPcTag}-f-{fltId}

[1] sys/actrl/scope-{id}/rule-{scopeId}-s-{sPcTag}-d-{dPcTag}-f-{fltId}

                

Diagram

Super Mo: actrl:ARule, Container Mos: actrl:Scope (deletable:yes), Contained Mos: vz:ObservableRuleOwner, vz:RuleOwner, vz:TrCreatedBy, Relations To: actrl:AuxRule, svccopy:DestGrp, vz:ToEPg, fv:ProtEPg, svcredir:DestGrp, sts:VNode, vlan:CktEp, Relations: actrl:RsAuxRule, actrl:RsToCopyDestGrp, actrl:RsToEpgConn, actrl:RsToEpgProt, actrl:RsToRedirDestGrp, actrl:RsToStsVNode, actrl:RsToVlanCkt,

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...          ├ actrl:Entity The ACTRL control plane entity information.            ├ actrl:Scope The scope of the zoning rules.              ├ actrl:Rule The zoning rules for tenant endpoint groups. 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...    ├ actrl:Entity The ACTRL control plane entity information.      ├ actrl:Scope The scope of the zoning rules.        ├ actrl:Rule The zoning rules for tenant endpoint groups.

Contained Hierarchy

actrl:Rule The zoning rules for tenant endpoint groups.  ├ actrl:RsAuxRule   ├ actrl:RsToCopyDestGrp  Relationship to the copy service object  ├ actrl:RsToEpgConn   ├ actrl:RsToEpgProt   ├ actrl:RsToRedirDestGrp  Relationship to the service object for pbr redirection  ├ actrl:RsToStsVNode   ├ actrl:RsToVlanCkt  Relationship to the vlan::CktEp Used for DVS USEG feature for ref counting number of Ckts using this rule Single vlanCktEp will be shared by multiple base EPGs in a given BD  ├ 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.    ├ 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    ├ tag:Annotation     ├ tag:Tag   ├ health:Inst A base class for a health score instance.(Switch only)  ├ vz:ObservableRuleOwner     ├ 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.  ├ vz:RuleOwner     ├ 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.  ├ vz:TrCreatedBy  Tracks the resource that created a Taboo rule.    ├ 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

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.        ├ actrl:ARule An ordered set of rules specifying access control policies based on src/dst policy tag and filter ID.          ├ actrl:Rule The zoning rules for tenant endpoint groups.

Stats

actrl:Rule The zoning rules for tenant endpoint groups.  ├ actrl:RuleHit15min A class that represents the most current statistics for rule hits in a 15 minute sampling interval. This class updates every 5 minutes.  ├ actrl:RuleHit1d A class that represents the most current statistics for rule hits in a 1 day sampling interval. This class updates every hour.  ├ actrl:RuleHit1h A class that represents the most current statistics for rule hits in a 1 hour sampling interval. This class updates every 15 minutes.  ├ actrl:RuleHit1mo A class that represents the most current statistics for rule hits in a 1 month sampling interval. This class updates every day.  ├ actrl:RuleHit1qtr A class that represents the most current statistics for rule hits in a 1 quarter sampling interval. This class updates every day.  ├ actrl:RuleHit1w A class that represents the most current statistics for rule hits in a 1 week sampling interval. This class updates every day.  ├ actrl:RuleHit1year A class that represents the most current statistics for rule hits in a 1 year sampling interval. This class updates every day.  ├ actrl:RuleHit5min A class that represents the most current statistics for rule hits in a 5 minute sampling interval. This class updates every 10 seconds.  ├ actrl:RuleHitHist15min A class that represents historical statistics for rule hits in a 15 minute sampling interval. This class updates every 5 minutes.  ├ actrl:RuleHitHist1d A class that represents historical statistics for rule hits in a 1 day sampling interval. This class updates every hour.  ├ actrl:RuleHitHist1h A class that represents historical statistics for rule hits in a 1 hour sampling interval. This class updates every 15 minutes.  ├ actrl:RuleHitHist1mo A class that represents historical statistics for rule hits in a 1 month sampling interval. This class updates every day.  ├ actrl:RuleHitHist1qtr A class that represents historical statistics for rule hits in a 1 quarter sampling interval. This class updates every day.  ├ actrl:RuleHitHist1w A class that represents historical statistics for rule hits in a 1 week sampling interval. This class updates every day.  ├ actrl:RuleHitHist1year A class that represents historical statistics for rule hits in a 1 year sampling interval. This class updates every day.  ├ actrl:RuleHitHist5min A class that represents historical statistics for rule hits in a 5 minute sampling interval. This class updates every 10 seconds.  ├ opflex:OvsContract15min A class that represents the most current statistics for ovs contract stats in a 15 minute sampling interval. This class updates every 5 minutes.  ├ opflex:OvsContract1d A class that represents the most current statistics for ovs contract stats in a 1 day sampling interval. This class updates every hour.  ├ opflex:OvsContract1h A class that represents the most current statistics for ovs contract stats in a 1 hour sampling interval. This class updates every 15 minutes.  ├ opflex:OvsContract1mo A class that represents the most current statistics for ovs contract stats in a 1 month sampling interval. This class updates every day.  ├ opflex:OvsContract1qtr A class that represents the most current statistics for ovs contract stats in a 1 quarter sampling interval. This class updates every day.  ├ opflex:OvsContract1w A class that represents the most current statistics for ovs contract stats in a 1 week sampling interval. This class updates every day.  ├ opflex:OvsContract1year A class that represents the most current statistics for ovs contract stats in a 1 year sampling interval. This class updates every day.  ├ opflex:OvsContract5min A class that represents the most current statistics for ovs contract stats in a 5 minute sampling interval. This class updates every 10 seconds.  ├ opflex:OvsContractHist15min A class that represents historical statistics for ovs contract stats in a 15 minute sampling interval. This class updates every 5 minutes.  ├ opflex:OvsContractHist1d A class that represents historical statistics for ovs contract stats in a 1 day sampling interval. This class updates every hour.  ├ opflex:OvsContractHist1h A class that represents historical statistics for ovs contract stats in a 1 hour sampling interval. This class updates every 15 minutes.  ├ opflex:OvsContractHist1mo A class that represents historical statistics for ovs contract stats in a 1 month sampling interval. This class updates every day.  ├ opflex:OvsContractHist1qtr A class that represents historical statistics for ovs contract stats in a 1 quarter sampling interval. This class updates every day.  ├ opflex:OvsContractHist1w A class that represents historical statistics for ovs contract stats in a 1 week sampling interval. This class updates every day.  ├ opflex:OvsContractHist1year A class that represents historical statistics for ovs contract stats in a 1 year sampling interval. This class updates every day.  ├ opflex:OvsContractHist5min A class that represents historical statistics for ovs contract stats in a 5 minute sampling interval. This class updates every 10 seconds.

action

Type: actrl:Action
Primitive Type: scalar:Bitmask32

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

The action required when the condition is met.

actrlCfgFailedBmp

Type: scalar:Bitmask64

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

The rule failed configuration information.

actrlCfgFailedTs

Type: scalar:Time

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

The day and time the configured rule failed.

actrlCfgState

Type: scalar:UByte

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

The rule configuration state.

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

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

Delete or ignore. For internal use only.

ctrctName

Type: naming:Name
Primitive Type: string:Basic

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

Contract name

dPcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

Overrides:actrl:ARule:dPcTag

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
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.

direction

Type: actrl:Direction
Primitive Type: scalar:Enum8

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

Specifies the connector direction.

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.

fltId

Type: actrl:FltId
Primitive Type: scalar:Uint32

Overrides:actrl:ARule:fltId

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

The rule filter identifier.

id

Type: actrl:RuleId
Primitive Type: scalar:Uint32

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

An identifier .

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.

markDscp

Type: qosp:Dscp
Primitive Type: scalar:UByte

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

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

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

operSt

Type: actrl:OperSt
Primitive Type: scalar:Enum8

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

The runtime state of the object or policy.

operStQual

Type: actrl:OperStQual
Primitive Type: scalar:Bitmask8

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

The chassis operational status qualifier.

prio

Type: actrl:RulePrio
Primitive Type: scalar:UByte

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

The QoS priority class ID.

qosGrp

Type: qos:Prio
Primitive Type: scalar:Enum8

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

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.

sPcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

Overrides:actrl:ARule:sPcTag

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

Specifies the source policy tag.

scopeId

Type: actrl:ScopeId
Primitive Type: scalar:Uint32

Overrides:actrl:ARule:scopeId

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

The scope identifier. Internally assigned.

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.

type

Type: actrl:RuleT
Primitive Type: scalar:Enum8

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

The specific type of the object or component.