Class dbg:ACProbe (CONCRETE)

Class ID:4053
Class Label: On-Demand Atomic Counter-based Probe
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
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: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The atomic counter probe.

Naming Rules
RN FORMAT: pb-{ruleName}

    [1] PREFIX=pb- PROPERTY = ruleName




DN FORMAT: 

[0] dbgs/ac/probes/pb-{ruleName}

[1] topology/pod-{id}/node-{id}/ndbgs/ac/probes/pb-{ruleName}

[2] ndbgs/ac/probes/pb-{ruleName}

                


Diagram

Container Mos: dbg:ACProbes (deletable:yes),
Contained Mos: dbg:ACPbPathStats, dbg:ACPbStats,


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] dbg:Cont IFC level debug apparatus container.
 
 ├
[V] dbg:AC The atomic counter.
 
 
 ├
[V] dbg:ACProbes The atomic counter probes.
 
 
 
 ├
[V] dbg:ACProbe The atomic counter probe.
[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] dbg:NDbgs The node debugs.
 
 
 
 
 ├
[V] dbg:AC The atomic counter.
 
 
 
 
 
 ├
[V] dbg:ACProbes The atomic counter probes.
 
 
 
 
 
 
 ├
[V] dbg:ACProbe The atomic counter probe.
[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] dbg:NDbgs The node debugs.
 
 ├
[V] dbg:AC The atomic counter.
 
 
 ├
[V] dbg:ACProbes The atomic counter probes.
 
 
 
 ├
[V] dbg:ACProbe The atomic counter probe.


Contained Hierarchy
[V] dbg:ACProbe The atomic counter probe.
 ├
[V] dbg:ACPbPathStats The atomic counter probe path statistics.
 ├
[V] dbg:ACPbStats Atomic Counter Probe stats from each node where this probe is deployed. Total count across all linecards in a node is maintained if there are multiple linecards and hence, multiple atomic counter block instances in a node.


Inheritance
[V] dbg:ACProbe The atomic counter probe.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: dbg:ACProbe
scalar:Uint64 dropP  (dbg:ACProbe:dropP)
           Last Collection number of dropped packets
scalar:Uint64 exssP  (dbg:ACProbe:exssP)
           Last Collection number of excess or unexpected packets
scalar:UByte percentDropP  (dbg:ACProbe:percentDropP)
           Last Collection Percentage of dropped packets as w.r.t. recvdP
scalar:UByte percentExssP  (dbg:ACProbe:percentExssP)
           Last Collection Percentage of excess packets as w.r.t. recvdP
scalar:UByte percentTotDropP  (dbg:ACProbe:percentTotDropP)
           Percentage of dropped packets as w.r.t. recvdP
scalar:UByte percentTotExssP  (dbg:ACProbe:percentTotExssP)
           Percentage of excess packets as w.r.t. recvdP
string:Basic ruleName  (dbg:ACProbe:ruleName)
           Probe Name
scalar:Uint64 rxP  (dbg:ACProbe:rxP)
           Last Collection number of received packets
dbg:PbAdSt
          scalar:Enum8
st  (dbg:ACProbe:st)
           State of the probe (enabled or disabled)
dbg:AcPbTgt
          scalar:Enum8
tgtType  (dbg:ACProbe:tgtType)
           Target Type of the Probe
scalar:Uint64 totDropP  (dbg:ACProbe:totDropP)
           Total number of dropped packets
scalar:Uint64 totExssP  (dbg:ACProbe:totExssP)
           Total number of excess or unexpected packets
scalar:Uint64 totRxP  (dbg:ACProbe:totRxP)
           Total number of received packets
scalar:Uint64 totTxP  (dbg:ACProbe:totTxP)
           Total number of Transmitted packets
scalar:Date ts  (dbg:ACProbe:ts)
           Last Update Timestamp
scalar:Uint64 txP  (dbg:ACProbe:txP)
           ********* Last Collection Values *********
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: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: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





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.



dropP

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Last Collection number of dropped packets



exssP

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Last Collection number of excess or unexpected packets



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





percentDropP

Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Last Collection Percentage of dropped packets as w.r.t. recvdP



percentExssP

Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Last Collection Percentage of excess packets as w.r.t. recvdP



percentTotDropP

Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Percentage of dropped packets as w.r.t. recvdP



percentTotExssP

Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Percentage of excess packets as w.r.t. recvdP



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
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Probe Name



rxP

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Last Collection number of received packets



st

Type: dbg:PbAdSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
State of the probe (enabled or disabled)
Constants
Enabled 1 Enabled NO COMMENTS
Disabled 2 Disabled NO COMMENTS
DEFAULT Disabled(2) Disabled 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.






tgtType

Type: dbg:AcPbTgt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Target Type of the Probe
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





totDropP

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Total number of dropped packets



totExssP

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Total number of excess or unexpected packets



totRxP

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Total number of received packets



totTxP

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Total number of Transmitted packets



ts

Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Last Update Timestamp



txP

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
********* Last Collection Values *********