| Name | Data Type | Value |
|---|---|---|
| Description | string | An AlarmDevice is a type of Device that emits audible or visible indications related to a problem situation. |
| UMLPackagePath | string | CIM::Device::Sensors |
| Version | string | 2.8.0 |
| Name | Data Type | Default Value | Qualifiers | ||||
|---|---|---|---|---|---|---|---|
| Name | Data Type | Value | |||||
| AlarmState | uint16 | ||||||
| Description | string | The current state of the alarm. | |||||
| ValueMap | string | 0, 1, 2, 3 | |||||
| Values | string | Unknown, Off, Steady, Alternating | |||||
| AudibleAlarm | boolean | ||||||
| Description | string | Boolean indicating that the Alarm is audible. | |||||
| AudioIndicatorIsDisabled | boolean | ||||||
| Description | string | True indicates that the audio of an AlarmState indicator has been disabled (i.e. muted). A disabled state here does not imply that the AlarmState is off. | |||||
| MotionAlarm | boolean | ||||||
| Description | string | Boolean indicating that the Alarm causes motion of the Device. | |||||
| MotionIndicatorIsDisabled | boolean | ||||||
| Description | string | True indicates that the motion of an AlarmState indicator has been disabled (i.e. stopped). A disabled state here does not imply that the AlarmState is off. | |||||
| Urgency | uint16 | ||||||
| Description | string | Urgency is an enumerated value that indicates the relative frequency at which the Alarm flashes, vibrates and/or emits audible tones. | |||||
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6 | |||||
| Values | string | Unknown, Other, Not Supported, Informational, Non-Critical, Critical, Unrecoverable | |||||
| VisibleAlarm | boolean | ||||||
| Description | string | Boolean indicating that the Alarm is visible. | |||||
| VisualIndicatorIsDisabled | boolean | ||||||
| Description | string | True indicates that the visual of an AlarmState indicator has been disabled (i.e. dimmed). A disabled state here does not imply that the AlarmState is off. | |||||
| Name | Data Type | Class Origin |
|---|---|---|
| Availability | uint16 | CIM_LogicalDevice |
| Caption | string | CIM_ManagedElement |
| CommunicationStatus | uint16 | CIM_ManagedSystemElement |
| CreationClassName | string | CIM_LogicalDevice |
| Description | string | CIM_ManagedElement |
| DetailedStatus | uint16 | CIM_ManagedSystemElement |
| DeviceID | string | CIM_LogicalDevice |
| ElementName | string | CIM_ManagedElement |
| EnabledDefault | uint16 | CIM_EnabledLogicalElement |
| EnabledState | uint16 | CIM_EnabledLogicalElement |
| ErrorCleared | boolean | CIM_LogicalDevice |
| ErrorDescription | string | CIM_LogicalDevice |
| Generation | uint64 | CIM_ManagedElement |
| HealthState | uint16 | CIM_ManagedSystemElement |
| InstallDate | datetime | CIM_ManagedSystemElement |
| InstanceID | string | CIM_ManagedElement |
| LastErrorCode | uint32 | CIM_LogicalDevice |
| LocationIndicator | uint16 | CIM_LogicalDevice |
| MaxQuiesceTime | uint64 | CIM_LogicalDevice |
| Name | string | CIM_ManagedSystemElement |
| OperatingStatus | uint16 | CIM_ManagedSystemElement |
| OtherEnabledState | string | CIM_EnabledLogicalElement |
| PowerManagementSupported | boolean | CIM_LogicalDevice |
| PowerOnHours | uint64 | CIM_LogicalDevice |
| PrimaryStatus | uint16 | CIM_ManagedSystemElement |
| RequestedState | uint16 | CIM_EnabledLogicalElement |
| Status | string | CIM_ManagedSystemElement |
| StatusInfo | uint16 | CIM_LogicalDevice |
| SystemCreationClassName | string | CIM_LogicalDevice |
| SystemName | string | CIM_LogicalDevice |
| TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement |
| TotalPowerOnHours | uint64 | CIM_LogicalDevice |
| TransitioningToState | uint16 | CIM_EnabledLogicalElement |
| AdditionalAvailability | uint16[] | CIM_LogicalDevice |
| AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement |
| IdentifyingDescriptions | string[] | CIM_LogicalDevice |
| OperationalStatus | uint16[] | CIM_ManagedSystemElement |
| OtherIdentifyingInfo | string[] | CIM_LogicalDevice |
| PowerManagementCapabilities | uint16[] | CIM_LogicalDevice |
| StatusDescriptions | string[] | CIM_ManagedSystemElement |
| Name | Data Type | Value |
|---|---|---|
| Description | string | SetAlarmState is a method for defining the current state of the Alarm. Its input parameter, RequestedAlarmState, is specified using the Values list of AlarmDevice's AlarmState property. SetAlarmState returns 0 if the request is successfully implemented, 1 if the specified RequestedAlarm State is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes should be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' should be specified as a Values array qualifier. |
| Name | Type | Qualifiers | ||||
|---|---|---|---|---|---|---|
| Name | Data Type | Value | ||||
| RequestedAlarmState | uint16 | |||||
| Description | string | The desired state for the alarm. | ||||
| IN | boolean | true | ||||
| ValueMap | string | 0, 1, 2, 3 | ||||
| Values | string | Unknown, Off, Steady, Alternating | ||||
| Name | Data Type | Value |
|---|---|---|
| Description | string | SetAlarmIndicator is a method for enabling or disabling the indicator of the AlarmState function, without changing the current AlarmState. It has 3 input parameters, Audio Indicator, VisualIndicator and MotionIndicator. For all of the input parameters, a value of 0 indicates no change to the AlarmState indicator, 1 indicates Disable, and 2 indicates Enable. The method returns 0 if the request is successfully implemented, 1 if the specified request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes should be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' should be specified as a Values array qualifier. |
| Name | Type | Qualifiers | ||||
|---|---|---|---|---|---|---|
| Name | Data Type | Value | ||||
| AudioIndicator | uint16 | |||||
| Description | string | The state for the audio indicator. | ||||
| IN | boolean | true | ||||
| ValueMap | string | 0, 1, 2 | ||||
| Values | string | No Change, Disable, Enable | ||||
| MotionIndicator | uint16 | |||||
| Description | string | The state for the motion indicator. | ||||
| IN | boolean | true | ||||
| ValueMap | string | 0, 1, 2 | ||||
| Values | string | No Change, Disable, Enable | ||||
| VisualIndicator | uint16 | |||||
| Description | string | The state for the visual indicator. | ||||
| IN | boolean | true | ||||
| ValueMap | string | 0, 1, 2 | ||||
| Values | string | No Change, Disable, Enable | ||||
| Name | Data Type | Value |
|---|---|---|
| Description | string | SetUrgency is a method for defining the desired urgency level for the Alarm. Its input parameter, RequestedUrgency, is specified using the Values list of AlarmDevice's Urgency property. SetUrgency returns 0 if the request is successfully implemented, 1 if the specified Urgency level is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes should be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' should be specified as a Values array qualifier. |
| Name | Type | Qualifiers | ||||
|---|---|---|---|---|---|---|
| Name | Data Type | Value | ||||
| RequestedUrgency | uint16 | |||||
| Description | string | Desired urgency for the alarm. | ||||
| IN | boolean | true | ||||
| ValueMap | string | 1, 3, 4, 5, 6 | ||||
| Values | string | Other, Informational, Non-Critical, Critical, Unrecoverable | ||||
| Name | Return Type | Class Origin |
|---|---|---|
| EnableDevice | uint32 | CIM_LogicalDevice |
| OnlineDevice | uint32 | CIM_LogicalDevice |
| QuiesceDevice | uint32 | CIM_LogicalDevice |
| RequestStateChange | uint32 | CIM_EnabledLogicalElement |
| Reset | uint32 | CIM_LogicalDevice |
| RestoreProperties | uint32 | CIM_LogicalDevice |
| SaveProperties | uint32 | CIM_LogicalDevice |
| SetPowerState | uint32 | CIM_LogicalDevice |