Class CIM_Button
extends CIM_LogicalDevice

CIM_Button models the logical aspects of a mechanical or electronic human interface device pressed to activate an electrical circuit in a computer. Mechanical buttons may include spring-loaded mechanical key or knobs. Electronic buttons may include touch-sensitive switches or screens. The Button object is used to model the manageable aspects of a Button.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_AllocatedLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_Button

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringCIM_Button models the logical aspects of a mechanical or electronic human interface device pressed to activate an electrical circuit in a computer. Mechanical buttons may include spring-loaded mechanical key or knobs. Electronic buttons may include touch-sensitive switches or screens. The Button object is used to model the manageable aspects of a Button.
Experimentalbooleantrue
UMLPackagePathstringCIM::Device::Button
Versionstring2.22.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
ButtonPurposeuint16
DescriptionstringThe ButtonPurpose property identifies or defines the use of the button represented by the instance. If the type is set to "Other", then the OtherButtonPurpose property can be used to further identify the purpose. Descriptions of the different Button purposes are as follows: A Power Button changes the power state of a device. A reset button is used to reset the state of a device. Undock is used to undock or disconnect a device or entire system from a separate device or system. An Open/Close button is used on a device that has an object that usually moves such as a drawer, door, or tray.
ModelCorrespondencestringCIM_Button.OtherButtonPurpose
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringUnknown, Other, Power, Reset, Undock, Open/Close, DMTF Reserved, Vendor Reserved
ButtonStateuint16
DescriptionstringThe current state of the button.
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, Deassert, Assert, DMTF Reserved, Vendor Reserved
ButtonTypeuint16
DescriptionstringThe ButtonType property identifies or defines the type the button represented by the instance. If the type is set to "Other", then the OtherButtonType property can be used to further identify the type. A momentary button is one that depressed for a moment to cause the desired affect the target device or circuit A toggle type button is one that will remain in a switched or depressed position until it is depressed or switched again.
ModelCorrespondencestringCIM_Button.OtherButtonType
ValueMapstring0, 1, 2, 3, .., 32768..65535
ValuesstringUnknown, Other, Momentary, Toggle, DMTF Reserved, Vendor Reserved
OtherButtonPurposestring
DescriptionstringA string describing the Button Purpose - used when the ButtonPurpose property is set to "Other".
MaxLenuint32128
ModelCorrespondencestringCIM_Button.ButtonPurpose
OtherButtonTypestring
DescriptionstringA string describing the Button Purpose - used when the ButtonType property is set to "Other".
MaxLenuint32128
ModelCorrespondencestringCIM_Button.ButtonType
ButtonActionMappingstring[]
ArrayTypestringIndexed
DescriptionstringButtonActionMapping shall identify the action that occurs if the ButtonState transitions to the value specified in the corresponding array index of the ButtonStateMapping property. Each value shall be formatted using the following algorithm: [OrgID]:[LocalID] Where [OrgID] and [LocalID] are separated by a colon (:), and where [OrgID] shall include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the string value or that is a registered ID assigned to the business entity by a recognized global authority. [OrgID] shall not contain a colon (:). [LocalID] is chosen by the business entity and shall not be reused to identify different underlying (real-world) elements. For DMTF defined values, [OrgID] shall be "DMTF". If ButtonPurpose contains the value 2 "Power", ButtonActionMapping shall contain one of the following values: "DMTF:PowerOn" - A transition to the state will result in a request to power on the associated element. "DMTF:PowerOff" - A transition to the state will result in a request to power off the associated element. "DMTF:PowerChange" - A transition to the state will result in a request to change the power state of the associated element. If ButtonPurpose contains the value 3 "Reset", ButtonActionMapping shall contain one of the following values: "DMTF:Reset" - A transition to the state will result in a request to reset the associated element. If ButtonPurpose contains the value 4 "Undock", ButtonActionMapping shall contain one of the following values: "DMTF:Undock" - A transition to the state will result in a request to undock the associated element. If ButtonPurpose contains the value 5 "OpenClose", ButtonActionMapping shall contain one of the following values: "DMTF:OpenCloseChange" - A transition to the state will result in a request to open or close the associated element as appropriate. That is, an open element will be closed, and a closed element will be opened. "DMTF:OpenCloseOpen" - A transition to the state will result in a request to open the associated element. "DMTF:OpenCloseClose" - A transition to the state will result in a request to close the associated element.
ModelCorrespondencestringCIM_Button.ButtonStateMapping
ButtonStateMappinguint16[]
ArrayTypestringIndexed
DescriptionstringButtonStateMapping identifies a supported button state that correlates to a specific action that will occur if the button transitions to the state.
ModelCorrespondencestringCIM_Button.ButtonActionMapping
ValueMapstring2, 3
ValuesstringDeassert, Assert

Inherited Properties

NameData Type
AllocationStatestring
Availabilityuint16
Captionstring
CommunicationStatusuint16
CreationClassNamestring
Descriptionstring
DetailedStatusuint16
DeviceIDstring
ElementNamestring
EnabledDefaultuint16
EnabledStateuint16
ErrorClearedboolean
ErrorDescriptionstring
Generationuint64
HealthStateuint16
InstallDatedatetime
InstanceIDstring
LastErrorCodeuint32
LocationIndicatoruint16
MaxQuiesceTimeuint64
Namestring
OperatingStatusuint16
OtherEnabledStatestring
PowerManagementSupportedboolean
PowerOnHoursuint64
PrimaryStatusuint16
RequestedStateuint16
Statusstring
StatusInfouint16
SystemCreationClassNamestring
SystemNamestring
TimeOfLastStateChangedatetime
TotalPowerOnHoursuint64
TransitioningToStateuint16
AdditionalAvailabilityuint16[]
AvailableRequestedStatesuint16[]
IdentifyingDescriptionsstring[]
OperationalStatusuint16[]
OtherIdentifyingInfostring[]
PowerManagementCapabilitiesuint16[]
StatusDescriptionsstring[]

Class Methods

Inherited Class Methods

NameReturn Type
EnableDeviceuint32
OnlineDeviceuint32
QuiesceDeviceuint32
RequestStateChangeuint32
Resetuint32
RestorePropertiesuint32
SavePropertiesuint32
SetPowerStateuint32