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

Class health:Record (CONCRETE)

Class ID:1640
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-protocol-ops]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Contains a complete snapshot of the health instance.

Naming Rules 
RN FORMAT: hr-{id}

    [1] PREFIX=hr- PROPERTY = id




DN FORMAT: 

[0] subj-{[oDn]}/hr-{id}


Diagram

Super Mo: condition:Record,
Container Mos: condition:Subj (deletable:yes), event:ProcessEventLogPayload (deletable:yes), fault:UpdateRecordPayload (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] condition:Subj This is generated and used only by internal processes.
 
 		 ├
 		[V] health:Record Contains a complete snapshot of the health instance.


Contained Hierarchy
[V] health:Record Contains a complete snapshot of the health instance.


Inheritance
[V] condition:Info Represents an abstract base class for all reportable and loggable objects.
 ├
 		[V] condition:Record A complete snapshot of loggable objects.
 
 		 ├
 		[V] health:Record Contains a complete snapshot of the health instance.


Events


Faults


Fsms


Properties Summary
Defined in: health:Record
scalar:Sint16 chng  (health:Record:chng)
           Specifies the percentage change of the current value compared to the previous value.
health:HsValT
          scalar:UByte 		cur  (health:Record:cur)
           The current value of the health score.
naming:Descr
          string:Basic 		descr  (health:Record:descr)
           Overrides:condition:Info:descr
           The description of the health record.
condition:Id
          scalar:Uint64 		id  (health:Record:id)
           Overrides:condition:Record:id
           null
condition:ActionIndicator
          scalar:Uint32 		ind  (health:Record:ind)
           A property to indicate whether the health instance was created, modified, or deleted.
condition:Severity
          scalar:Enum8 		maxSev  (health:Record:maxSev)
           Holds highest severity of all faults that impact the health score.
health:HsValT
          scalar:UByte 		prev  (health:Record:prev)
           Holds the previous value of the health score.
health:HsValT
          scalar:UByte 		twScore  (health:Record:twScore)
           Holds the time weighted average.
Defined in: condition:Record
reference:BinRef affected  (condition:Record:affected)
          
Defined in: condition:Info
scalar:Date created  (condition:Info:created)
           A property that indicates when this object was created.
condition:Severity
          scalar:Enum8 		severity  (condition:Info:severity)
           A property that indicates severity level of the reportable object.
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

affected

Type: reference:BinRef

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    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




chng

Type: scalar:Sint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the percentage change of the current value compared to the previous value.


created

Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A property that indicates when this object was created.


cur

Type: health:HsValT
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The current value of the health score.


descr

Type: naming:Descr
Primitive Type: string:Basic

Overrides:condition:Info:descr

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The description of the health record.


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.


id

Type: condition:Id
Primitive Type: scalar:Uint64

Overrides:condition:Record:id

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


ind

Type: condition:ActionIndicator
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
A property to indicate whether the health instance was created, modified, or deleted.
Constants
creation 0u creation NO COMMENTS
modification 1u modification NO COMMENTS
deletion 2u deletion NO COMMENTS
state-transition 3u state-transition NO COMMENTS
special 4u special NO COMMENTS
failure 5u failure NO COMMENTS
DEFAULT special(4u) special NO COMMENTS




maxSev

Type: condition:Severity
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Holds highest severity of all faults that impact the health score.
Constants
cleared 0 cleared The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given). Multiple associated notifications may be cleared by using the Correlated notifications parameter (defined below).
info 1 info NO COMMENTS
warning 2 warning The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.
minor 3 minor The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.
major 4 major The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.
critical 5 critical The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.
DEFAULT info(1) info 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




prev

Type: health:HsValT
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Holds the previous value of the health score.


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.


severity

Type: condition:Severity
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A property that indicates severity level of the reportable object.
Constants
cleared 0 cleared The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given). Multiple associated notifications may be cleared by using the Correlated notifications parameter (defined below).
info 1 info NO COMMENTS
warning 2 warning The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.
minor 3 minor The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.
major 4 major The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.
critical 5 critical The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.
DEFAULT info(1) info 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.





twScore

Type: health:HsValT
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Holds the time weighted average.




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