Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class vz:RuleOwner (CONCRETE)

Class ID:9495
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model for 64b processes - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
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: own-{[creatorDn]}-tag-{tag}

    [1] PREFIX=own- PROPERTY = creatorDn


    [2] PREFIX=-tag- PROPERTY = tag




DN FORMAT: 

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

[1] sys/actrl/scope-{id}/sr-{scopeId}-s-{sPcTag}-d-{dPcTag}-f-{fltId}/own-{[creatorDn]}-tag-{tag}

[2] topology/pod-{id}/node-{id}/sys/actrl/scope-{id}/mr-{scopeId}-s-{sPcTag}-d-{dPcTag}-f-{fltId}/own-{[creatorDn]}-tag-{tag}

[3] sys/actrl/scope-{id}/mr-{scopeId}-s-{sPcTag}-d-{dPcTag}-f-{fltId}/own-{[creatorDn]}-tag-{tag}

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

[5] sys/actrl/scope-{id}/rule-{scopeId}-s-{sPcTag}-d-{dPcTag}-f-{fltId}/own-{[creatorDn]}-tag-{tag}


Diagram

Super Mo: vz:ARuleOwner,
Container Mos: actrl:ARule (deletable:yes),


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] actrl:Entity The ACTRL control plane entity information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] actrl:Scope The scope of the zoning rules.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] actrl:SnmpRule The zoning rules for SNMP endpoint groups.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:RuleOwner 
[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] actrl:Entity The ACTRL control plane entity information.
 
 		 
 		 ├
 		[V] actrl:Scope The scope of the zoning rules.
 
 		 
 		 
 		 ├
 		[V] actrl:SnmpRule The zoning rules for SNMP endpoint groups.
 
 		 
 		 
 		 
 		 ├
 		[V] vz:RuleOwner 
[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] actrl:Entity The ACTRL control plane entity information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] actrl:Scope The scope of the zoning rules.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] actrl:MgmtRule The zoning rules for management endpoint groups.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:RuleOwner 
[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] actrl:Entity The ACTRL control plane entity information.
 
 		 
 		 ├
 		[V] actrl:Scope The scope of the zoning rules.
 
 		 
 		 
 		 ├
 		[V] actrl:MgmtRule The zoning rules for management endpoint groups.
 
 		 
 		 
 		 
 		 ├
 		[V] vz:RuleOwner 
[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] actrl:Entity The ACTRL control plane entity information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] actrl:Scope The scope of the zoning rules.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] actrl:Rule The zoning rules for tenant endpoint groups.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:RuleOwner 
[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] actrl:Entity The ACTRL control plane entity information.
 
 		 
 		 ├
 		[V] actrl:Scope The scope of the zoning rules.
 
 		 
 		 
 		 ├
 		[V] actrl:Rule The zoning rules for tenant endpoint groups.
 
 		 
 		 
 		 
 		 ├
 		[V] vz:RuleOwner 


Contained Hierarchy
[V] vz:RuleOwner 
 ├
 		[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] vz:ARuleOwner 
 
 		 
 		 ├
 		[V] vz:RuleOwner 


Events


Faults


Fsms


Properties Summary
Defined in: vz:RuleOwner
reference:BinRef creatorDn  (vz:RuleOwner:creatorDn)
           Overrides:vz:ARuleOwner:creatorDn
           NO COMMENTS
vz:RuleTag
          scalar:Enum8 		tag  (vz:RuleOwner:tag)
           Overrides:vz:ARuleOwner:tag
           The color of a policy label.
Defined in: vz:ARuleOwner
actrl:Action
          scalar:Bitmask32 		action  (vz:ARuleOwner:action)
           The action required when the condition is met.
naming:Name
          string:Basic 		ctrctName  (vz:ARuleOwner:ctrctName)
           NO COMMENTS
actrl:Direction
          scalar:Enum8 		direction  (vz:ARuleOwner:direction)
           The connector direction.
vz:Intent
          scalar:Enum8 		intent  (vz:ARuleOwner:intent)
           NO COMMENTS
qosp:Dscp
          scalar:UByte 		markDscp  (vz:ARuleOwner:markDscp)
           DSCP values to apply for QOS
reference:BinRef monitorDn  (vz:ARuleOwner:monitorDn)
           NO COMMENTS
actrl:RulePrio
          scalar:UByte 		prio  (vz:ARuleOwner:prio)
           The QoS priority class ID.
qos:Prio
          scalar:Enum8 		qosGrp  (vz:ARuleOwner:qosGrp)
           The classification of Qos class.
actrl:RuleT
          scalar:Enum8 		type  (vz:ARuleOwner:type)
           The specific type of the object or component.
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: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.
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: actrl:Action
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The action required when the condition is met.
Constants
permit_override 1024u permit override NO COMMENTS
redir_override 128u redir override NO COMMENTS
deny 16u Deny deny
count 1u count count
no_stats 256u no stats NO COMMENTS
log 2u log log
copy 32u copy NO COMMENTS
permit 4u permit NO COMMENTS
analytics_vld 512u enable analytics NO COMMENTS
threshold_redir 64u redirect with threshold NO COMMENTS
redir 8u redirect NO COMMENTS
DEFAULT permit(4u) permit 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




creatorDn

Type: reference:BinRef

Overrides:vz:ARuleOwner:creatorDn

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


ctrctName

Type: naming:Name
Primitive Type: string:Basic

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


direction

Type: actrl:Direction
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The connector direction.
Constants
uni-dir 1 Uni-directional Unidirectional
bi-dir 2 Bi-directional Unidirectional
uni-dir-ignore 3 Uni-directional-Ignore Unidirectional-Ignore - used with the dummy Rule Mo, which accompanies the bi-dir Rule Mo
DEFAULT uni-dir(1) Uni-directional Unidirectional




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.


intent

Type: vz:Intent
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
install 0 install rules in hardware NO COMMENTS
estimate_delete 1 process configuration and estimate number of rules for deleting contract NO COMMENTS
estimate_add 2 process configuration and estimate number of rules for adding contract NO COMMENTS
DEFAULT install(0) install rules in hardware 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




markDscp

Type: qosp:Dscp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
DSCP values to apply for QOS
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




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




monitorDn

Type: reference:BinRef

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


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

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


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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


prio

Type: actrl:RulePrio
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The QoS priority class ID.
Constants
class-eq-filter 1 class-eq-filter NO COMMENTS
class-eq-deny 2 class-eq-deny NO COMMENTS
class-eq-allow 3 class-eq-allow NO COMMENTS
prov-nonshared-to-cons 4 prov-nonshared-to-cons NO COMMENTS
black_list 5 black_list NO COMMENTS
fabric_infra 6 fabric_infra NO COMMENTS
fully_qual 7 fully_qual NO COMMENTS
system_incomplete 8 system_incomplete NO COMMENTS
src_dst_any 9 src_dst_any NO COMMENTS
shsrc_any_filt_perm 10 shsrc_any_filt_perm NO COMMENTS
shsrc_any_any_perm 11 shsrc_any_any_perm NO COMMENTS
shsrc_any_any_deny 12 shsrc_any_any_deny NO COMMENTS
src_any_filter 13 src_any_filter NO COMMENTS
any_dest_filter 14 any_dest_filter NO COMMENTS
src_any_any 15 src_any_any NO COMMENTS
any_dest_any 16 any_dest_any NO COMMENTS
any_any_filter 17 any_any_filter NO COMMENTS
grp_src_any_any_deny 18 grp_src_any_any_deny NO COMMENTS
grp_any_dest_any_deny 19 grp_any_dest_any_deny NO COMMENTS
grp_any_any_any_permit 20 grp_any_any_any_permit NO COMMENTS
any_any_any 21 any_any_any NO COMMENTS
any_vrf_any_deny 22 any_vrf_any_deny NO COMMENTS
default_action 23 default_action NO COMMENTS
DEFAULT 0 --- Rule priority, this is the priority for a set of rules




qosGrp

Type: qos:Prio
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The classification of Qos class.
Constants
unspecified 0 Unspecified NO COMMENTS
level3 1 Level3 (Default) User configurable classes
level2 2 Level2 NO COMMENTS
level1 3 Level1 NO COMMENTS
policy-plane 4 policy-plane System Classes. Not user configurable
control-plane 5 control-plane NO COMMENTS
span 6 span NO COMMENTS
level6 7 Level6 NO COMMENTS
level5 8 Level5 NO COMMENTS
level4 9 Level4 NO COMMENTS
DEFAULT unspecified(0) Unspecified 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.


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.





tag

Type: vz:RuleTag
Primitive Type: scalar:Enum8

Overrides:vz:ARuleOwner:tag

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The color of a policy label.
Constants
unknown 0 unknown NO COMMENTS
vrf 1 vrf NO COMMENTS
bd 2 bd NO COMMENTS
to-epg 3 to-epg NO COMMENTS
to-epg-any 4 to-epg-any NO COMMENTS
arepp 5 arepp NO COMMENTS
vlanckt 6 vlanckt NO COMMENTS
taboo 7 taboo NO COMMENTS
filter 8 filter NO COMMENTS
mgmt 9 mgmt NO COMMENTS
DEFAULT unknown(0) unknown NO COMMENTS




type

Type: actrl:RuleT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
tenant 1 Tenant tenant
mgmt 2 Management management
snmp 3 SNMP snmp
bd_flood 4 Flood BD flood rule
vrf_default 5 Vrf Vrf default rule
infra 6 Infra Infra rule
DEFAULT tenant(1) Tenant tenant






Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail