Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class dbg:ACRulePCommon (ABSTRACT)

Class ID:4006
Class Label: Atomic Counter Entry Policy Common Fields
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, fabric-connectivity-mgmt, fabric-connectivity-util, fabric-equipment, ops, tenant-connectivity-mgmt, tenant-connectivity-util]
Read Access: [admin, fabric-connectivity-mgmt, fabric-connectivity-util, fabric-equipment, ops, tenant-connectivity-mgmt, tenant-connectivity-util]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The atomic counter rule policy common.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: pol:Comp,
Sub Mos: dbg:ACRuleIp,


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:Comp Represents a policy component. This object is part of the policy definition.
 
 		 
 		 ├
 		[V] dbg:ACRulePCommon The atomic counter rule policy common.
 
 		 
 		 
 		 ├
 		[V] dbg:ACRuleIp The IP match rule policy for atomic counter probe.


Events


Faults


Fsms


Properties Summary
Defined in: dbg:ACRulePCommon
nw:AdminSt
          scalar:Enum8 		adminSt  (dbg:ACRulePCommon:adminSt)
           Administrative state of the monitoring policy
actrl:PcTag
          scalar:Uint32 		dPcTag  (dbg:ACRulePCommon:dPcTag)
           Destination policy tag
base:Encap fabricEncap  (dbg:ACRulePCommon:fabricEncap)
           fabric encap, a zero value means a wildcard
ac:PortId
          base:IfIndex 		fabricPort  (dbg:ACRulePCommon:fabricPort)
           fabric port id
dbg:OperSt
          scalar:Enum8 		operSt  (dbg:ACRulePCommon:operSt)
           Operational State of the policy
dbg:OperStQual
          string:Basic 		operStQual  (dbg:ACRulePCommon:operStQual)
           Operational state qualifier
ac:PayloadSz
          scalar:UByte 		payloadSz  (dbg:ACRulePCommon:payloadSz)
           Payload size
string:Basic ruleName  (dbg:ACRulePCommon:ruleName)
           Entry Policy Name
actrl:PcTag
          scalar:Uint32 		sPcTag  (dbg:ACRulePCommon:sPcTag)
           Source policy tag
dbg:AcRuleTgt
          scalar:Enum8 		tgt  (dbg:ACRulePCommon:tgt)
           Target Type of the Rule
scalar:Date ts  (dbg:ACRulePCommon:ts)
           Last Update Timestamp
dbg:AcRuleWildcard
          scalar:Bitmask64 		wildcard  (dbg:ACRulePCommon:wildcard)
           wildcard bitmask, if a bit is set the field corresponding to that bit position is treated as a wildcard
Defined in: pol:Comp
naming:Descr
          string:Basic 		descr  (pol:Comp:descr)
           Specifies the description of a policy 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: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

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Administrative state of the monitoring policy
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled




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




dPcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
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
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies the description of a policy component.


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.


fabricEncap

Type: base:Encap

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
fabric encap, a zero value means a wildcard


fabricPort

Type: ac:PortId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
fabric port id


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
null


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS


operSt

Type: dbg:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Operational State of the policy
Constants
up 1 Up Up
down 2 Down Down
failed 3 Failed Failed
partial 4 Partial Partially Up - up for some but not for all of them
DEFAULT down(2) Down Down




operStQual

Type: dbg:OperStQual
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
Operational state qualifier


payloadSz

Type: ac:PayloadSz
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Payload size
Constants
dont-care 0xff Wildcard Payload Size NO COMMENTS
DEFAULT 0 --- Payload size




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.


ruleName

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
Entry Policy Name


sPcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Source policy tag
Constants
any 0u any NO COMMENTS
DEFAULT 0 --- Policy control tag




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.





tgt

Type: dbg:AcRuleTgt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Target Type of the Rule
Constants
Unknown 0 Unknown Unknown
SrcL 1 SrcL Source leaf node
DstL 2 DstL Destn. leaf node
SrcDstL 3 SrcDstL Src. & Dest. leaf nodes
SrcDstLS 4 SrcDstLS Src. & Dest. leaf nodes and a Spine node
SrcDstLSAll 5 SrcDstLSAll Src. & Dest. leaf nodes and all Spine nodes
all 6 all All linecards on all nodes
DEFAULT all(6) all All linecards on all nodes




ts

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Last Update Timestamp


wildcard

Type: dbg:AcRuleWildcard
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
wildcard bitmask, if a bit is set the field corresponding to that bit position is treated as a wildcard
Constants
All 0ull All Wildcarded Default - All Wildcarded
SrcL4Port 10ull Source Layer4 Port Source L4 Port
SrcPolTag 11ull Source Policy Tag Source Policy Tag
SrcTep 12ull Source Tunnel Endpoint Source Tunnel Endpoint
DestPort 13ull Destination Port *********** DESTINATION FIELDS ********** Destination Port: Not supported Placeholder
DestMac 14ull Destination MAC Address Destination MAC
DestIp 15ull Destination IP Address Destination IP Address
DestL4Port 16ull Destination Layer4 Port Destination L4 Port
DestPolTag 17ull Destination Policy Tag Destination Policy Tag
DestTep 18ull Destination Tunnel Endpoint Destination Tunnel Endpoint: Not supported - Placeholder
IcmpType 19ull ICMP Type *********** OTHER FIELDS ********** ICMP Type
RuleOrder 1ull Rule Order *********** GENERAL FIELDS ********** Rule Order
ArpOpcode 20ull ARP Opcode ARP Opcode
ArpSenderMac 21ull ARP Sender MAC ARP Sender MAC
ArpTgtMac 22ull ARP Target MAC ARP Target MAC
ArpTgtIp 23ull ARP Target IP ARP Target IP
EtherType 2ull Ether type Ethertype
Encap 3ull Encapsulation Encapsulation
L3Protocol 4ull Layer 3 Protocol Layer 3 Protocol
TTL 5ull Time-to-live TTL
PayloadSize 6ull Payload Size Payload Size
SrcPort 7ull Source Port *********** SOURCE FIELDS ********** Source Port
SrcMac 8ull Source MAC Address Source MAC
SrcIp 9ull Source IP Address Source IP Address
DEFAULT All(0ull) All Wildcarded Default - All Wildcarded






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail