RecordLog, ROOT\Hardware\ms_409

Class | Methods (2) | Properties (17) | Qualifiers (3) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

RecordLog for IPMI

RecordLog methods

RecordLog has 2 methods (2 Derived)

NameOriginReturn
ClearLogCIM_Loguint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}

RecordLog properties

RecordLog has 17 properties (17 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
CurrentNumberOfRecordsCIM_Log21 [uint64]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
key
InstanceID
CIM_RecordLog8 [string]
MaxNumberOfRecordsCIM_Log21 [uint64]
NameCIM_ManagedSystemElement8 [string]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]

Detailed description of RecordLog methods

Derived methods (2) of RecordLog class

ClearLog method
Returnuint32 {'out':True}
Description'Requests that the Log be cleared of all entries.
The return value should be 0 if the request was successfully executed, 1 if the request is not supported, and some other value, as indicated by the ValueMap/Values qualifiers, if an error occurred.'
Values['Completed with no error', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'DMTF_Reserved', 'Method_Reserved', 'Vendor_Reserved']
ClearLog method is in 3 classes of ROOT\Hardware\ms_409 and in 4 namespaces
RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the instance's RequestedState property if the RequestStateChange method's return code is 0, 3, or 4096 (0x1000) - 'Completed with No Error', 'Timeout', or 'Job Started' respectively. Refer to the description of the EnabledState and RequestedState properties for the detailed meanings of the RequestedState values.','Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'Reference to the job (may be null if task completed).'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format MUST be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation doesn't support this parameter. A return code of 'Use Of Timeout Parameter Not Supported' MUST be returned.'}
Description'Requests that the element's state be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the element's EnabledState and RequestedState will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten/lost.
If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.'
Values['Completed with No Error', 'Not Supported', 'Unknown/Unspecified Error', 'Can NOT complete within Timeout Period', 'Failed', 'Invalid Parameter', 'In Use', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Invalid State Transition', 'Use of Timeout Parameter Not Supported', 'Busy', 'Method Reserved', 'Vendor Specific']
RequestStateChange method is in 14 classes of ROOT\Hardware\ms_409 and in 15 namespaces

Detailed description of RecordLog properties

Derived properties (17) of RecordLog class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 33 classes of ROOT\Hardware\ms_409 and in 37 namespaces
CurrentNumberOfRecords property
CIMTYPE'uint64'
Description'Current number of records in the Log.'
CurrentNumberOfRecords property is in 3 classes of ROOT\Hardware\ms_409 and in 2 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 34 classes of ROOT\Hardware\ms_409 and in 142 namespaces
ElementName property
CIMTYPE'string'
Description'A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information.
Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties.'
ElementName property is in 33 classes of ROOT\Hardware\ms_409 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
Description'An enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2).'
Values['Enabled', 'Disabled', 'Not Applicable', 'Enabled but Offline', 'No Default', 'DMTF Reserved', 'Vendor Reserved']
EnabledDefault property is in 14 classes of ROOT\Hardware\ms_409 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
Description'EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states:
Enabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests.
Disabled (3) indicates that the element will not execute commands and will drop any new requests.
Shutting Down (4) indicates that the element is in the process of going to a Disabled state.
Not Applicable (5) indicates the element doesn't support being enabled/disabled.
Enabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests.
Test (7) indicates that the element is in a test state.
Deferred (8) indicates that the element may be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.'
Values['Unknown', 'Other', 'Enabled', 'Disabled', 'Shutting Down', 'Not Applicable', 'Enabled but Offline', 'In Test', 'Deferred', 'Quiesce', 'Starting', 'DMTF Reserved', 'Vendor Reserved']
EnabledState property is in 14 classes of ROOT\Hardware\ms_409 and in 13 namespaces
HealthState property
CIMTYPE'uint16'
Description'Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined:
"Non-recoverable Error" (30) - The element has completed failed and recovery is not possible. All functionality provided by this element has been lost.
"Critical Failure" (25) - The element is non-functional and recovery MAY NOT be possible.
"Major Failure" (20) - The element is failing. It is possible the some or all of the functionality of this component is degraded or not working.
"Minor Failure" (15) - All functionality is available but some MAY be degraded.
"Degraded/Warning" (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element may not be operating at optimal performance or it may be reporting recoverable errors.
"OK" (5) - The element is fully functional and is operating within normal operational parameters and without error.
"Unknown" (0) - The implementation can not report on HealthState at this time.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.'
Values['Unknown', 'OK', 'Degraded/Warning', 'Minor failure', 'Major failure', 'Critical failure', 'Non-recoverable error', 'DMTF Reserved']
HealthState property is in 18 classes of ROOT\Hardware\ms_409 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
Description'A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
InstallDate property is in 18 classes of ROOT\Hardware\ms_409 and in 23 namespaces
InstanceID property
CIMTYPE'string'
Description'Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class.
In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
:
Where and are separated by a colon ':', and where MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between and .
is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm MUST be used with the set to 'CIM'.'
keyTrue
InstanceID property is in 11 classes of ROOT\Hardware\ms_409 and in 21 namespaces
MaxNumberOfRecords property
CIMTYPE'uint64'
Description'Maximum number of records that can be captured in the Log. If undefined, a value of zero should be specified.'
MaxNumberOfRecords property is in 3 classes of ROOT\Hardware\ms_409 and in 2 namespaces
Name property
CIMTYPE'string'
Description'The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.'
Name property is in 26 classes of ROOT\Hardware\ms_409 and in 142 namespaces
OperationalStatus property
CIMTYPE'uint16'
Description'Indicates the current status(es) of the element. Various operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail.
"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc.
"Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future.
"In Service" describes an element being configured, maintained, cleaned, or otherwise administered.
"No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
"Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
"Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" describes that this element may be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems.
"Completed" indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.
"Power Mode" indicates the element has additional power model information contained in the Associated PowerManagementService association.
OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element.'
Values['Unknown', 'Other', 'OK', 'Degraded', 'Stressed', 'Predictive Failure', 'Error', 'Non-Recoverable Error', 'Starting', 'Stopping', 'Stopped', 'In Service', 'No Contact', 'Lost Communication', 'Aborted', 'Dormant', 'Supporting Entity in Error', 'Completed', 'Power Mode', 'DMTF Reserved', 'Vendor Reserved']
OperationalStatus property is in 18 classes of ROOT\Hardware\ms_409 and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
Description'A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1.'
OtherEnabledState property is in 14 classes of ROOT\Hardware\ms_409 and in 11 namespaces
RequestedState property
CIMTYPE'uint16'
Description'RequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration.

It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.

This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code.

It is possible that a particular instance of EnabledLogicalElement may not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.'
Values['Enabled', 'Disabled', 'Shut Down', 'No Change', 'Offline', 'Test', 'Deferred', 'Quiesce', 'Reboot', 'Reset', 'Not Applicable', 'DMTF Reserved', 'Vendor Reserved']
RequestedState property is in 14 classes of ROOT\Hardware\ms_409 and in 12 namespaces
Status property
CIMTYPE'string'
Description'A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.'
Status property is in 18 classes of ROOT\Hardware\ms_409 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
Description'Strings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.'
StatusDescriptions property is in 18 classes of ROOT\Hardware\ms_409 and in 18 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
Description'The date/time when the element's EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated.'
TimeOfLastStateChange property is in 14 classes of ROOT\Hardware\ms_409 and in 17 namespaces

RecordLog Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'RecordLog for IPMI'
LOCALE1033

RecordLog System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Hardware\ms_409:RecordLog'___SYSTEM8
__NAMESPACE'ROOT\Hardware\ms_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_RecordLog', 'CIM_Log', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT17___SYSTEM3
__RELPATH'RecordLog'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_RecordLog'___SYSTEM8
__CLASS'RecordLog'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to RecordLog

Number of classes:7
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_EnabledLogicalElement3141----
CIM_Log1162----
CIM_LogicalDevice1318----
CIM_LogicalElement290----
CIM_LogRecord1110----
CIM_RecordLog1172----
LogRecord0110----
comments powered by Disqus
WUtils.com