Class actrl:AuxRule (CONCRETE)

Class ID:2465
Class Label: Access Control Auxillary Rule
Encrypted: false - Exportable: false - Persistent: false - 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: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The auxiliary rule information.

Naming Rules
RN FORMAT: rule-{id}

    [1] PREFIX=rule- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/actrl/aux/rule-{id}

[1] sys/actrl/aux/rule-{id}

                


Diagram

Super Mo: nw:CpSt,
Container Mos: actrl:AuxSt (deletable:yes),
Relations From: actrl:ARule,
Relations: actrl:RtAuxRule,


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:AuxSt The auxiliary state of the process, used for internal information.
 
 
 
 
 
 
 ├
[V] actrl:AuxRule The auxiliary rule information.
[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:AuxSt The auxiliary state of the process, used for internal information.
 
 
 
 ├
[V] actrl:AuxRule The auxiliary rule information.


Contained Hierarchy
[V] actrl:AuxRule The auxiliary rule information.
 ├
[V] actrl:RtAuxRule A target relation to the auxiliary rule information.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] nw:CpSt A control plane state.
 
 ├
[V] actrl:AuxRule The auxiliary rule information.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: actrl:AuxRule
actrl:Action
          scalar:Bitmask32
action  (actrl:AuxRule:action)
           The action required when the condition is met.
string:Basic ctrName  (actrl:AuxRule:ctrName)
           Contract name
actrl:Direction
          scalar:Enum8
direction  (actrl:AuxRule:direction)
           The connector direction.
actrl:RuleFlag
          scalar:Bitmask8
flags  (actrl:AuxRule:flags)
           The IP address flags.
actrl:FltId
          scalar:Uint32
fltid  (actrl:AuxRule:fltid)
           The filter ID.
actrl:RuleId
          scalar:Uint32
id  (actrl:AuxRule:id)
           An identifier.
actrl:RulePrio
          scalar:UByte
prio  (actrl:AuxRule:prio)
           The QoS priority class ID.
actrl:PpfNodeId
          scalar:Uint32
ruleNodeId  (actrl:AuxRule:ruleNodeId)
           The internal rule node ID.
actrl:ScopeId
          scalar:Uint32
scopeId  (actrl:AuxRule:scopeId)
           The scope identifier. Internally assigned.
Defined in: naming:NamedObject
naming:Name
          string:Basic
name  (naming:NamedObject:name)
           The name of the object.
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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





ctrName

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Contract name



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.



flags

Type: actrl:RuleFlag
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IP address flags.
Constants
nostats 1 Stats is disabled stats enabled
DEFAULT 0 --- Remote Chunk flags.





fltid

Type: actrl:FltId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The filter ID.
Constants
implarp 0xfffdu Implicit filter id for arp NO COMMENTS
implicit 0xfffeu Implicit filter id for internal consumption NO COMMENTS
default 0xffffu Default filter id This is the default filter id, representing a wildcard
DEFAULT 0 --- Filter id





id

Type: actrl:RuleId
Primitive Type: scalar:Uint32

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



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

Like: naming:Named: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



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





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.



ruleNodeId

Type: actrl:PpfNodeId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The internal rule node ID.



scopeId

Type: actrl:ScopeId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The scope identifier. Internally assigned.
Constants
defaultValue 1u --- 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.