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

Class comm:ApiAvgRespTime (CONCRETE)

Class ID:16066
Class Label: Response Time Non Configurable
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Resolved Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [aaa, admin, fabric-equipment]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: true ]

NO COMMENTS

Naming Rules 
RN FORMAT: apiAvgResp

    [1] PREFIX=apiAvgResp


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/web/apiAvgResp

[1] web/apiAvgResp


Diagram

Container Mos: comm:WebServer (deletable:yes),
Contained Mos: comm:RequestData,


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] comm:WebServer 
 
 		 
 		 
 		 
 		 ├
 		[V] comm:ApiAvgRespTime 
[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] comm:WebServer 
 
 		 ├
 		[V] comm:ApiAvgRespTime 


Contained Hierarchy
[V] comm:ApiAvgRespTime 
 ├
 		[V] comm:RequestData 


Inheritance
[V] comm:ApiAvgRespTime 


Events 
                comm:ApiAvgRespTime:comm_ApiAvgRespTime_RequestsExceededReqRespTime

                comm:ApiAvgRespTime:comm_ApiAvgRespTime_NoRequestsExceededReqRespTime


Faults


Fsms


Properties Summary
Defined in: comm:ApiAvgRespTime
comm:ApiEventState
          scalar:Enum8 		apiState  (comm:ApiAvgRespTime:apiState)
           This field is used to create an event based on the reqExceed Value
scalar:Uint32 avgRespTime  (comm:ApiAvgRespTime:avgRespTime)
           This field is used to display the average time calculated.
reference:BinRef monPolDn  (comm:ApiAvgRespTime:monPolDn)
           The monitoring policy attached to this observable object.
scalar:Uint32 reqExceed  (comm:ApiAvgRespTime:reqExceed)
           This field is used to denote the number of requests that exceeded the threshold
scalar:Uint32 reqServed  (comm:ApiAvgRespTime:reqServed)
           This field is used to set the number of requests served in last time period
comm:ApiResponseState
          scalar:Enum8 		runningStatus  (comm:ApiAvgRespTime:runningStatus)
           This field is used to set the status of API as slow or normal.
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

apiState

Type: comm:ApiEventState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
This field is used to create an event based on the reqExceed Value
Constants
No change 0 No change in Response time behavior NO COMMENTS
Requests Slow 1 One or more requests took longer than expected to complete NO COMMENTS
Requests Normal 2 API Response time is back to normal timings NO COMMENTS
DEFAULT No change(0) No change in Response time behavior NO COMMENTS




avgRespTime

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
This field is used to display the average time calculated.


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.


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




monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.


reqExceed

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
This field is used to denote the number of requests that exceeded the threshold


reqServed

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
This field is used to set the number of requests served in last time period


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.


runningStatus

Type: comm:ApiResponseState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
This field is used to set the status of API as slow or normal.
Constants
normal 0 Api sesponse time is normal NO COMMENTS
slow 1 Api response time is slow NO COMMENTS
DEFAULT normal(0) Api sesponse time is normal 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.







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