SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_Controller

CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_LogicalDevice
               extended by CIM_Controller
Known Subclasses:
CIM_PCIController AMT_PCIDevice 
Abstract class CIM_Controller
 extends CIM_LogicalDevice


General Information:
Controller is a superclass for grouping the 
miscellaneous control-related Devices that provide a classic bus master 
interface. Examples of Controllers are USBControllers, SerialControllers, and so 
on. The Controller class is an abstraction for Devices with a single protocol 
stack, which exist to control communications (data, control, and reset) to 
downstream devices. Note that a new abstract class (ProtocolController) has been 
created to model more complex interface controllers such as 
SCSI.

Qualifiers:
-------------
Abstract
Version=2.10.0
UMLPackagePath=CIM::Device::Controller









  
  

    Supported Fields 
      Summary

  

     uint64 
      
    MaxQuiesceTime 
      
The MaxQuiesceTime property has been deprecated . . .

  

     uint16[] 
      
    AdditionalAvailability 
      
Additional availability and status of the Device, beyond that 
      specified in the Availability property . . .

  

     string[] 
      
    IdentifyingDescriptions 
      
An array of free-form strings providing explanations and 
      details behind the entries in the OtherIdentifyingInfo array . . .

  

     uint64 
      
    TotalPowerOnHours 
      
The total number of hours that this Device has been 
    powered.

  

     uint64 
      
    PowerOnHours 
The 
      number of consecutive hours that this Device has been powered, since its 
      last power cycle.

  

     string[] 
      
    OtherIdentifyingInfo 
      
OtherIdentifyingInfo captures additional data, beyond DeviceID 
      information, that could be used to identify a LogicalDevice . . .

  

     boolean 
      
    ErrorCleared 
      
ErrorCleared is a boolean property indicating that the error 
      reported in LastErrorCode is now cleared.

  

     string 
      
    ErrorDescription 
      
ErrorDescription is a free-form string supplying more 
      information about the error recorded in LastErrorCode, and information on 
      any corrective actions that may be taken.

  

     uint32 
      
    LastErrorCode 
      
LastErrorCode captures the last error code reported by the 
      LogicalDevice.

  

     uint16 
      
    StatusInfo 
The 
      StatusInfo property indicates whether the Logical Device is in an enabled 
      (value = 3), disabled (value = 4) or some other (1) or unknown (2) state . 
      . .

  

     uint16 
      
    Availability 
The 
      primary availability and status of the Device . . .

  

     uint16[] 
      
    PowerManagementCapabilities 
      
An enumerated array describing the power management 
      capabilities of the Device . . .

  

     boolean 
      
    PowerManagementSupported 
      
Boolean indicating that the Device can be power managed . . 
      .

  

     string 
      
    DeviceID Key  
An address or other identifying information to 
      uniquely name the LogicalDevice.

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     string 
      
    SystemName Key  
The scoping System's Name.

  

     string 
      
    SystemCreationClassName Key  
The scoping System's 
      CreationClassName.

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    Description 
The 
      Description property provides a textual description of the object.

  

     string 
      
    Caption 
The Caption 
      property is a short textual description (one- line string) of the 
      object.

  

     datetime 
      
    InstallDate 
A 
      datetime value that indicates when the object was installed . . .

  

     string 
      
    Name 
The Name property 
      defines the label by which the object is known . . .

  

     uint16[] 
      
    OperationalStatus 
      
Indicates the current statuses of the element . . .

  

     string[] 
      
    StatusDescriptions 
      
Strings describing the various OperationalStatus array values . 
      . .

  

     string 
      
    Status 
A string 
      indicating the current status of the object . . .

  

     uint16 
      
    HealthState 
      
Indicates the current health of the element . . .

  

     uint16 
      
    EnabledState 
      
EnabledState is an integer enumeration that indicates the 
      enabled and disabled states of an element . . .

  

     string 
      
    OtherEnabledState 
      
A string that describes the enabled or disabled state of the 
      element when the EnabledState property is set to 1 ("Other") . . .

  

     uint16 
      
    RequestedState 
      
RequestedState is an integer enumeration that indicates the 
      last requested or desired state for the element, irrespective of the 
      mechanism through which it was requested . . .

  

     uint16 
      
    EnabledDefault 
      
An enumerated value indicating an administrator's default or 
      startup configuration for the Enabled State of an element . . .

  

     datetime 
      
    TimeOfLastStateChange 
The 
      date or time when the EnabledState of the element last changed . . 
.

  

     datetime 
      
    TimeOfLastReset 
      
Time of last reset of the Controller.

  

     uint16 
      
    ProtocolSupported 
      
The protocol used by the Controller to access controlled 
      Devices.

  

     uint32 
      
    MaxNumberControlled 
      
Maximum number of directly addressable entities that are 
      supported by this Controller . . .

  

     string 
      
    ProtocolDescription 
      
A free-form string that provides more information that is 
      related to the ProtocolSupported by the 
Controller.




  
  

    Methods Summary

  

     uint32
    RestoreProperties() 
Requests 
      that the Device re-establish its configuration, setup and/or state 
      information from a backing store . . .

  

     uint32
    SaveProperties() 
      
Requests that the Device capture its current configuration, setup 
      and/or state information in a backing store . . .

  

     uint32
    QuiesceDevice(Quiesce) 
The 
      QuiesceDevice method has been deprecated in lieu of the more general 
      RequestStateChange method that directly overlaps with the functionality 
      provided by this method . . .

  

     uint32
    OnlineDevice(Online) 
      
The OnlineDevice method has been deprecated in lieu of the more 
      general RequestStateChange method that directly overlaps with the 
      functionality provided by this method . . .

  

     uint32
    EnableDevice(Enabled) 
      
The EnableDevice method has been deprecated in lieu of the more 
      general RequestStateChange method that directly overlaps with the 
      functionality provided by this method . . .

  

     uint32
    Reset() 
Requests a reset 
      of the LogicalDevice . . .

  

     uint32
    SetPowerState(PowerState, 
      Time) 
Sets the power state of the Device . . .

  

     uint32
    RequestStateChange(RequestedState, REF 
      Job, TimeoutPeriod) 
Requests that the state of the element be 
      changed to the value specified in the RequestedState parameter . . 
.

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context

  

     
    Subscribe() 
      
Subscribes to this resource (WS-Eventing)

  

     
    Unsubscribe() 
      
Remove subscription to this resource 
  (WS-Eventing)




  
  

    Field 
Detail


MaxQuiesceTime 
public uint64 MaxQuiesceTime



  
General Information:
The MaxQuiesceTime property has been 
  deprecated. When evaluating the use of Quiesce, it was determine that this 
  single property is not adequate for describing when a device will 
  automatically exit a quiescent state. In fact, the most likely scenario for a 
  device to exit a quiescent state was determined to be based on the number of 
  outstanding requests queued rather than on a maximum time. This will be 
  re-evaluated and repositioned later. 
Maximum time in milliseconds, that a 
  Device can run in a "Quiesced" state. A Device's state is defined in its 
  Availability and AdditionalAvailability properties, where "Quiesced" is 
  conveyed by the value 21. What occurs at the end of the time limit is 
  device-specific. The Device may unquiesce, may offline or take other action. A 
  value of 0 indicates that a Device can remain quiesced 
  indefinitely.

Qualifiers:
-------------
Deprecated={No 
  value}
Units=MilliSeconds


  

  





AdditionalAvailability 
public uint16[] AdditionalAvailability



  
General Information:
Additional availability and status of the 
  Device, beyond that specified in the Availability property. The Availability 
  property denotes the primary status and availability of the Device. In some 
  cases, this will not be sufficient to denote the complete status of the 
  Device. In those cases, the AdditionalAvailability property can be used to 
  provide further information. For example, a Device's primary Availability may 
  be "Off line" (value=8), but it may also be in a low power state 
  (AdditonalAvailability value=14), or the Device could be running Diagnostics 
  (AdditionalAvailability value=5, "In 
  Test").

Qualifiers:
-------------
ValueMap={1, 2, 3, 4, 5, 
  6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21}
Values={Other, 
  Unknown, Running/Full Power, Warning, In Test, Not Applicable, Power Off, Off 
  Line, Off Duty, Degraded, Not Installed, Install Error, Power Save - Unknown, 
  Power Save - Low Power Mode, Power Save - Standby, Power Cycle, Power Save - 
  Warning, Paused, Not Ready, Not Configured, 
  Quiesced}
ModelCorrespondence={CIM_LogicalDevice.Availability}


  

  





IdentifyingDescriptions 
public string[] IdentifyingDescriptions



  
General Information:
An array of free-form strings providing 
  explanations and details behind the entries in the OtherIdentifyingInfo array. 
  Note, each entry of this array is related to the entry in OtherIdentifyingInfo 
  that is located at the same 
  index.

Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_LogicalDevice.OtherIdentifyingInfo}
MaxLen=256


  

  





TotalPowerOnHours 
public uint64 TotalPowerOnHours



  
General Information:
The total number of hours that this Device 
  has been 
  powered.

Qualifiers:
-------------
Units=Hours
Counter


  

  





PowerOnHours 
public uint64 PowerOnHours



  
General Information:
The number of consecutive hours that this 
  Device has been powered, since its last power 
  cycle.

Qualifiers:
-------------
Units=Hours
Counter


  

  





OtherIdentifyingInfo 
public string[] OtherIdentifyingInfo



  
General Information:
OtherIdentifyingInfo captures additional 
  data, beyond DeviceID information, that could be used to identify a 
  LogicalDevice. One example would be to hold the Operating System's user 
  friendly name for the Device in this 
  property.

Qualifiers:
-------------
ArrayType=Indexed
MaxLen=256
ModelCorrespondence={CIM_LogicalDevice.IdentifyingDescriptions}


  

  





ErrorCleared 
public boolean ErrorCleared



  
General Information:
ErrorCleared is a boolean property 
  indicating that the error reported in LastErrorCode is now 
  cleared.

Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}


  

  





ErrorDescription 
public string ErrorDescription



  
General Information:
ErrorDescription is a free-form string 
  supplying more information about the error recorded in LastErrorCode, and 
  information on any corrective actions that may be 
  taken.

Qualifiers:
-------------
Deprecated={CIM_DeviceErrorData.ErrorDescription}
MaxLen=256


  

  





LastErrorCode 
public uint32 LastErrorCode



  
General Information:
LastErrorCode captures the last error code 
  reported by the 
  LogicalDevice.

Qualifiers:
-------------
Deprecated={CIM_DeviceErrorData.LastErrorCode}


  

  





StatusInfo 
public uint16 StatusInfo



  
General Information:
The StatusInfo property indicates whether 
  the Logical Device is in an enabled (value = 3), disabled (value = 4) or some 
  other (1) or unknown (2) state. If this property does not apply to the 
  LogicalDevice, the value, 5 ("Not Applicable"), should be used. StatusInfo has 
  been deprecated in lieu of a more clearly named property with additional 
  enumerated values (EnabledState), that is inherited from ManagedSystemElement. 
  
If a Device is ("Enabled")(value=3), it has been powered up, and is 
  configured and operational. The Device may or may not be functionally active, 
  depending on whether its Availability (or AdditionalAvailability) indicate 
  that it is ("Running/Full Power")(value=3) or ("Off line") (value=8). In an 
  enabled but offline mode, a Device may be performing out-of-band requests, 
  such as running Diagnostics. If ("Disabled") StatusInfo value=4), a Device can 
  only be "enabled" or powered off. In a personal computer environment, 
  ("Disabled") means that the Device's driver is not available in the stack. In 
  other environments, a Device can be disabled by removing its configuration 
  file. A disabled device is physically present in a System and consuming 
  resources, but can not be communicated with until a load of a driver, a load 
  of a configuration file or some other "enabling" activity has 
  occurred.

Qualifiers:
-------------
Deprecated={CIM_EnabledLogicalElement.EnabledState}
ValueMap={1, 
  2, 3, 4, 5}
Values={Other, Unknown, Enabled, Disabled, Not 
  Applicable}
MappingStrings={MIF.DMTF|Operational State|006.4}


  

  





Availability 
public uint16 Availability



  
General Information:
The primary availability and status of the 
  Device. (Additional status information can be specified using the Additional 
  Availability array property.) For example, the Availability property indicates 
  that the Device is running and has full power (value=3), or is in a warning 
  (4), test (5), degraded (10) or power save state (values 13-15 and 17). 
  Regarding the Power Save states, these are defined as follows: Value 13 
  ("Power Save - Unknown") indicates that the Device is known to be in a power 
  save mode, but its exact status in this mode is unknown; 14 ("Power Save - Low 
  Power Mode") indicates that the Device is in a power save state but still 
  functioning, and may exhibit degraded performance; 15 ("Power Save - Standby") 
  describes that the Device is not functioning but could be brought to full 
  power 'quickly'; and value 17 ("Power Save - Warning") indicates that the 
  Device is in a warning state, though also in a power save 
  mode.

Qualifiers:
-------------
ValueMap={1, 2, 3, 4, 5, 
  6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21}
Values={Other, 
  Unknown, Running/Full Power, Warning, In Test, Not Applicable, Power Off, Off 
  Line, Off Duty, Degraded, Not Installed, Install Error, Power Save - Unknown, 
  Power Save - Low Power Mode, Power Save - Standby, Power Cycle, Power Save - 
  Warning, Paused, Not Ready, Not Configured, 
  Quiesced}
MappingStrings={MIF.DMTF|Operational State|006.5, 
  MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus, MIF.DMTF|Host 
  Device|001.5}
ModelCorrespondence={CIM_LogicalDevice.AdditionalAvailability}


  

  





PowerManagementCapabilities 
public uint16[] PowerManagementCapabilities



  
General Information:
An enumerated array describing the power 
  management capabilities of the Device. The use of this property has been 
  deprecated. Instead, the PowerCapabilites property in an associated 
  PowerManagementCapabilities class should be 
  used.

Qualifiers:
-------------
Deprecated={CIM_PowerManagementCapabilities.PowerCapabilities}
ValueMap={0, 
  1, 2, 3, 4, 5, 6, 7}
Values={Unknown, Not Supported, Disabled, Enabled, 
  Power Saving Modes Entered Automatically, Power State Settable, Power Cycling 
  Supported, Timed Power On Supported}


  

  





PowerManagementSupported 
public boolean PowerManagementSupported



  
General Information:
Boolean indicating that the Device can be 
  power managed. The use of this property has been deprecated. Instead, the 
  existence of an associated PowerManagementCapabilities class (associated using 
  the ElementCapabilities relationhip) indicates that power management is 
  supported.

Qualifiers:
-------------
Deprecated={CIM_PowerManagementCapabilities}


  

  





DeviceID Key 
public string DeviceID



  
General Information:
An address or other identifying information 
  to uniquely name the 
  LogicalDevice.

Qualifiers:
-------------
Key
MaxLen=64


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
CreationClassName indicates the name of the 
  class or the subclass used in the creation of an instance. When used with the 
  other key properties of this class, this property allows all instances of this 
  class and its subclasses to be uniquely 
  identified.

Qualifiers:
-------------
Key
MaxLen=256


  

  





SystemName Key 
public string SystemName



  
General Information:
The scoping System's 
  Name.

Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.Name


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The scoping System's 
  CreationClassName.

Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.CreationClassName


  

  





ElementName 
public string ElementName



  
General Information:
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 
  the Name property of ManagedSystemElement 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 can be present in both the Name and 
  ElementName properties. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that 
class.

Qualifiers:
-------------
MaxLen=256


  

  





Description 
public string Description



  
General Information:
The Description property provides a textual 
  description of the 
  object.

Qualifiers:
-------------
MaxLen=256


  

  





Caption 
public string Caption



  
General Information:
The Caption property is a short textual 
  description (one- line string) of the 
  object.

Qualifiers:
-------------
MaxLen=64


  

  





InstallDate 
public datetime InstallDate



  
General Information:
A datetime value that indicates when the 
  object was installed. Lack of a value does not indicate that the object is not 
  installed.

Qualifiers:
-------------
MappingStrings={MIF.DMTF|ComponentID|001.5}


  

  





Name 
public string Name



  
General Information:
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.

Qualifiers:
-------------
MaxLen=1024


  

  





OperationalStatus 
public uint16[] OperationalStatus



  
General Information:
Indicates the current statuses 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 here in 
  more detail. 
"Stressed" indicates that the element is functioning, but 
  needs attention. Examples of "Stressed" states are overload, overheated, and 
  so on. 
"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 state and configuration of the element might need to be 
  updated. 
"Dormant" indicates that the element is inactive or quiesced. 
  
"Supporting Entity in Error" indicates that this element might 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 that the element has completed its 
  operation. This value should be combined with either OK, Error, or Degraded so 
  that a client can tell if the complete operation Completed with OK (passed), 
  Completed with Error (failed), or Completed with Degraded (the operation 
  finished, but it did not complete OK or did not report an error). 
"Power 
  Mode" indicates that the element has additional power model information 
  contained in the Associated PowerManagementService association. 
  
"Relocating" indicates the element is being 
  relocated.
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 
  because it required the deprecated qualifier. Due to the widespread use of the 
  existing Status property in management applications, it is strongly 
  recommended that providers or 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 
  (because it is single-valued) should also provide the primary status of the 
  element.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, .., 
  0x8000..}
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, Relocating, DMTF Reserved, Vendor 
  Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}


  

  





StatusDescriptions 
public string[] StatusDescriptions



  
General Information:
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.

Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.OperationalStatus}
MaxLen=256


  

  





Status 
public string Status



  
General Information:
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 definition overcomes the 
  limitation of describing status using a single value, when it is really a 
  multi-valued property (for example, an element might be OK AND Stopped. 
2) 
  A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 
  
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.

Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK, 
  Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, 
  NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10


  

  





HealthState 
public uint16 HealthState



  
General Information:
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 completely 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 might not be 
  possible. 
"Major Failure" (20) - The element is failing. It is possible 
  that some or all of the functionality of this component is degraded or not 
  working. 
"Minor Failure" (15) - All functionality is available but some 
  might 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 might not be operating 
  at optimal performance or it might 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 cannot report on HealthState at this time. 
DMTF has 
  reserved the unused portion of the continuum for additional HealthStates in 
  the future.

Qualifiers:
-------------
ValueMap={0, 5, 10, 
  15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning, 
  Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF 
  Reserved, Vendor Specific}


  

  





EnabledState 
public uint16 EnabledState



  
General Information:
EnabledState is an integer enumeration that 
  indicates the enabled and 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 and 
  disabled states: 
Enabled (2) indicates that the element is or 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 does not support being enabled or disabled. 
Enabled but Offline 
  (6) indicates that the element might 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 might be completing commands, but 
  will queue any new requests. 
Quiesce (9) indicates that the element is 
  enabled but in a restricted mode.
Starting (10) indicates that the element 
  is in the process of going to an Enabled state. New requests are 
  queued.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 
  5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other, 
  Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In 
  Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


  

  





OtherEnabledState 
public string OtherEnabledState



  
General Information:
A string that describes the enabled or 
  disabled state of the element when the EnabledState property is set to 1 
  ("Other"). This property must be set to null when EnabledState is any value 
  other than 
  1.

Qualifiers:
-------------
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
MaxLen=256


  

  





RequestedState 
public uint16 RequestedState



  
General Information:
RequestedState is an integer enumeration 
  that indicates the last requested or desired state for the element, 
  irrespective of the mechanism through which it was requested. The actual state 
  of the element is represented by EnabledState. This property is provided to 
  compare the last requested and current enabled or disabled states. Note that 
  when EnabledState is set to 5 ("Not Applicable"), then this property has no 
  meaning. Refer to the EnabledState property description for explanations of 
  the values in the RequestedState enumeration. 
"Unknown" (0) indicates the 
  last requested state for the element is unknown.
Note that the value "No 
  Change" (5) has been deprecated in lieu of indicating the last requested state 
  is "Unknown" (0). If the last requested or desired state is unknown, 
  RequestedState should have the value "Unknown" (0), but may have the value "No 
  Change" (5).Offline (6) indicates that the element has been requested to 
  transition to the Enabled but Offline EnabledState. 
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). Reboot refers to doing 
  a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the 
  element is first "Disabled" and then "Enabled". The distinction between 
  requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests 
  an orderly transition to the Disabled state, and might involve removing power, 
  to completely erase any existing state. 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 can be overridden and defined as WRITEable in a subclass. The method 
  approach is considered superior to a WRITEable property, because it allows an 
  explicit invocation of the operation and the return of a result code. 
  

If knowledge of the last RequestedState is not supported for the 
  EnabledLogicalElement, the property shall be NULL or have the value 12 "Not 
  Applicable".

Qualifiers:
-------------
ValueMap={0, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled, 
  Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, 
  Reset, Not Applicable, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}


  

  





EnabledDefault 
public uint16 EnabledDefault



  
General Information:
An enumerated value indicating an 
  administrator's default or startup configuration for the Enabled State of an 
  element. By default, the element is "Enabled" 
  (value=2).

Qualifiers:
-------------
Write
ValueMap={2, 
  3, 5, 6, 7, 9, .., 32768..65535}
Values={Enabled, Disabled, Not Applicable, 
  Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor 
  Reserved}


  

  





TimeOfLastStateChange 
public datetime TimeOfLastStateChange



  
General Information:
The date or time when the EnabledState of 
  the element 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.

  

  





TimeOfLastReset 
public datetime TimeOfLastReset



  
General Information:
Time of last reset of the Controller.

  

  





ProtocolSupported 
public uint16 ProtocolSupported



  
General Information:
The protocol used by the Controller to 
  access controlled 
  Devices.

Qualifiers:
-------------
ValueMap={1, 2, 3, 4, 
  5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 
  26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 
  45, 46, 47, 48}
Values={Other, Unknown, EISA, ISA, PCI, ATA/ATAPI, Flexible 
  Diskette, 1496, SCSI Parallel Interface, SCSI Fibre Channel Protocol, SCSI 
  Serial Bus Protocol, SCSI Serial Bus Protocol-2 (1394), SCSI Serial Storage 
  Architecture, VESA, PCMCIA, Universal Serial Bus, Parallel Protocol, ESCON, 
  Diagnostic, I2C, Power, HIPPI, MultiBus, VME, IPI, IEEE-488, RS232, IEEE 802.3 
  10BASE5, IEEE 802.3 10BASE2, IEEE 802.3 1BASE5, IEEE 802.3 10BROAD36, IEEE 
  802.3 100BASEVG, IEEE 802.5 Token-Ring, ANSI X3T9.5 FDDI, MCA, ESDI, IDE, CMD, 
  ST506, DSSI, QIC2, Enhanced ATA/IDE, AGP, TWIRP (two-way infrared), FIR (fast 
  infrared), SIR (serial infrared), IrBus, Serial 
  ATA}
MappingStrings={MIF.DMTF|Bus Port|004.2, 
  MIF.DMTF|Disks|003.3}
ModelCorrespondence={CIM_Controller.ProtocolDescription}


  

  





MaxNumberControlled 
public uint32 MaxNumberControlled



  
General Information:
Maximum number of directly addressable 
  entities that are supported by this Controller. A value of 0 should be used if 
  the number is unknown or 
  unlimited.

Qualifiers:
-------------
MappingStrings={MIF.DMTF|Bus 
  Port|004.9}


  

  





ProtocolDescription 
public string ProtocolDescription



  
General Information:
A free-form string that provides more 
  information that is related to the ProtocolSupported by the 
  Controller.

Qualifiers:
-------------
MappingStrings={MIF.DMTF|Bus 
  Port|004.3}
ModelCorrespondence={CIM_Controller.ProtocolSupported}
MaxLen=256


  

  






  
  

    Method 
Detail


RestoreProperties
public uint32 RestoreProperties()



  
Permission Information:
No permissions defined

General 
  Information:
Requests that the Device re-establish its configuration, 
  setup and/or state information from a backing store. The intent is to capture 
  this information at an earlier time (via the SaveProperties method), and use 
  it to return a Device to this earlier "condition". This method may not be 
  supported by all Devices. The method should return 0 if successful, 1 if the 
  request is not supported, and some other value if any other error occurred. In 
  a subclass, the set of possible return codes could be specified, using a 
  ValueMap qualifier on the method. The strings to which the ValueMap contents 
  are 'translated' may also be specified in the subclass as a Values array 
  qualifier.





SaveProperties
public uint32 SaveProperties()



  
Permission Information:
No permissions defined

General 
  Information:
Requests that the Device capture its current 
  configuration, setup and/or state information in a backing store. The goal 
  would be to use this information at a later time (via the RestoreProperties 
  method), to return a Device to its present "condition". This method may not be 
  supported by all Devices. The method should return 0 if successful, 1 if the 
  request is not supported, and some other value if any other error occurred. In 
  a subclass, the set of possible return codes could be specified, using a 
  ValueMap qualifier on the method. The strings to which the ValueMap contents 
  are 'translated' may also be specified in the subclass as a Values array 
  qualifier.





QuiesceDevice
public uint32 QuiesceDevice([IN]boolean Quiesce)



  
Permission Information:
No permissions defined

General 
  Information:
The QuiesceDevice method has been deprecated in lieu of 
  the more general RequestStateChange method that directly overlaps with the 
  functionality provided by this method. 
Requests that the LogicalDevice 
  cleanly cease all current activity ("Quiesce" input parameter = TRUE) or 
  resume activity (= FALSE). For this method to quiesce a Device, that Device 
  should have an Availability (or Additional Availability) of "Running/Full 
  Power" (value=3) and an EnabledStatus/StatusInfo of "Enabled". For example, if 
  quiesced, a Device may then be offlined for diagnostics, or disabled for power 
  off and hot swap. For the method to "unquiesce" a Device, that Device should 
  have an Availability (or AdditionalAvailability) of "Quiesced" (value=21) and 
  an EnabledStatus/StatusInfo of "Enabled". In this case, the Device would be 
  returned to an "Enabled" and "Running/Full Power" status. 
The method's 
  return code should indicate the success or failure of the quiesce. It should 
  return 0 if successful, 1 if the request is not supported at all, 2 if the 
  request is not supported due to the current state of the Device, and some 
  other value if any other error occurred. In a subclass, the set of possible 
  return codes could be specified, using a ValueMap qualifier on the method. The 
  strings to which the ValueMap contents are 'translated' may also be specified 
  in the subclass as a Values array 
  qualifier.

Qualifiers:
-------------
Deprecated={CIM_EnabledLogicalElement.RequestStateChange}


Parameters:
--------------

  

    
Quiesce 
    
General Information:
If set to TRUE then cleanly cease all 
    activity, if FALSE resume 
    activity.

Qualifiers:
-------------
IN







OnlineDevice
public uint32 OnlineDevice([IN]boolean Online)



  
Permission Information:
No permissions defined

General 
  Information:
The OnlineDevice method has been deprecated in lieu of the 
  more general RequestStateChange method that directly overlaps with the 
  functionality provided by this method. 
Requests that the LogicalDevice be 
  brought online ("Online" input parameter = TRUE) or taken offline (= FALSE). 
  "Online" indicates that the Device is ready to accept requests, and is 
  operational and fully functioning. In this case, the Device's Availability 
  property would be set to a value of 3 ("Running/Full Power"). "Offline" 
  indicates that a Device is powered up and operational, but not processing 
  functional requests. In an offline state, a Device may be capable of running 
  diagnostics or generating operational alerts. For example, when the "Offline" 
  button is pushed on a Printer, the Device is no longer available to process 
  print jobs, but could be available for diagnostics or maintenance. 
If this 
  method is successful, the Device's Availability and AdditionalAvailability 
  properties should reflect the updated status. If a failure occurs trying to 
  bring the Device online or offline, it should remain in its current state. IE, 
  the request, if unsuccessful, should not leave the Device in an indeterminate 
  state. When bringing a Device back "Online", from an "Offline" mode, the 
  Device should be restored to its last "Online" state, if at all possible. Only 
  a Device that has an EnabledState/StatusInfo of "Enabled" and has been 
  configured can be brought online or taken offline. 
OnlineDevice should 
  return 0 if successful, 1 if the request is not supported at all, 2 if the 
  request is not supported due to the current state of the Device, and some 
  other value if any other error occurred. In a subclass, the set of possible 
  return codes could be specified, using a ValueMap qualifier on the method. The 
  strings to which the ValueMap contents are 'translated' may also be specified 
  in the subclass as a Values array qualifier. 
Note that this method's 
  function overlaps with the RequestedState property. RequestedState was added 
  to the model to maintain a record (i.e., a persisted value) of the last state 
  request. Invoking the OnlineDevice method should set the RequestedState 
  property 
  appropriately.

Qualifiers:
-------------
Deprecated={CIM_EnabledLogicalElement.RequestStateChange}


Parameters:
--------------

  

    
Online 
    
General Information:
If TRUE, take the device online, if 
    FALSE, take the device 
    OFFLINE.

Qualifiers:
-------------
IN







EnableDevice
public uint32 EnableDevice([IN]boolean Enabled)



  
Permission Information:
No permissions defined

General 
  Information:
The EnableDevice method has been deprecated in lieu of the 
  more general RequestStateChange method that directly overlaps with the 
  functionality provided by this method. 
Requests that the LogicalDevice be 
  enabled ("Enabled" input parameter = TRUE) or disabled (= FALSE). If 
  successful, the Device's StatusInfo/EnabledState properties should reflect the 
  desired state (enabled/disabled). Note that this method's function overlaps 
  with the RequestedState property. RequestedState was added to the model to 
  maintain a record (i.e., a persisted value) of the last state request. 
  Invoking the EnableDevice method should set the RequestedState property 
  appropriately. 
The return code should be 0 if the request was successfully 
  executed, 1 if the request is not supported and some other value if an error 
  occurred. In a subclass, the set of possible return codes could be specified, 
  using a ValueMap qualifier on the method. The strings to which the ValueMap 
  contents are 'translated' may also be specified in the subclass as a Values 
  array 
  qualifier.

Qualifiers:
-------------
Deprecated={CIM_EnabledLogicalElement.RequestStateChange}


Parameters:
--------------

  

    
Enabled 
    
General Information:
If TRUE enable the device, if FALSE 
    disable the 
    device.

Qualifiers:
-------------
IN







Reset
public uint32 Reset()



  
Permission Information:
No permissions defined

General 
  Information:
Requests a reset of the LogicalDevice. The return value 
  should be 0 if the request was successfully executed, 1 if the request is not 
  supported and some other value if an error occurred. In a subclass, the set of 
  possible return codes could be specified, using a ValueMap qualifier on the 
  method. The strings to which the ValueMap contents are 'translated' may also 
  be specified in the subclass as a Values array qualifier.





SetPowerState
public uint32 SetPowerState([IN]uint16 PowerState, [IN]datetime Time)



  
Permission Information:
No permissions defined

General 
  Information:
Sets the power state of the Device. The use of this method 
  has been deprecated. Instead, use the SetPowerState method in the associated 
  PowerManagementService 
  class.

Qualifiers:
-------------
Deprecated={CIM_PowerManagementService.SetPowerState}


Parameters:
--------------

  

    
PowerState 
    
General Information:
The power state to 
    set.

Qualifiers:
-------------
IN
ValueMap={1, 2, 3, 
    4, 5, 6}
Values={Full Power, Power Save - Low Power Mode, Power Save - 
    Standby, Power Save - Other, Power Cycle, Power Off}


    
Time 
    
General Information:
Time indicates when the power state 
    should be set, either as a regular date-time value or as an interval value 
    (where the interval begins when the method invocation is 
    received.

Qualifiers:
-------------
IN







RequestStateChange
public uint32 RequestStateChange([IN]uint16 RequestedState, [OUT]REF CIM_ConcreteJob Job, [IN]datetime TimeoutPeriod)



  
Permission Information:
No permissions defined

General 
  Information:
Requests that the state of the element be changed to the 
  value specified in the RequestedState parameter. When the requested state 
  change takes place, the EnabledState and RequestedState of the element will be 
  the same. Invoking the RequestStateChange method multiple times could result 
  in earlier requests being overwritten or lost. 
A return code of 0 shall 
  indicate the state change was successfully initiated. 
A return code of 3 
  shall indicate that the state transition cannot complete within the interval 
  specified by the TimeoutPeriod parameter. 
A return code of 4096 (0x1000) 
  shall indicate the state change was successfully initiated, a ConcreteJob has 
  been created, and its reference returned in the output parameter Job. Any 
  other return code indicates an error 
  condition.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 
  32768..65535}
Values={Completed with No Error, Not Supported, Unknown or 
  Unspecified Error, Cannot 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}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


Parameters:
--------------

  

    
RequestedState 
    
General Information:
The state requested for the element. This 
    information will be placed into the RequestedState property of the instance 
    if the return code of the RequestStateChange method is 0 ('Completed with No 
    Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the 
    EnabledState and RequestedState properties for the detailed explanations of 
    the RequestedState 
    values.

Qualifiers:
-------------
IN
ValueMap={2, 3, 
    4, 6, 7, 8, 9, 10, 11, .., 32768..65535}
Values={Enabled, Disabled, Shut 
    Down, Offline, Test, Defer, Quiesce, Reboot, Reset, DMTF Reserved, Vendor 
    Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


    
Job 
    
General Information:
May contain a reference to the 
    ConcreteJob created to track the state transition initiated by the method 
    invocation.

Qualifiers:
-------------
IN=false
OUT


    
TimeoutPeriod 
    
General Information:
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 does not support this parameter, a 
    return code of 'Use Of Timeout Parameter Not Supported' shall be 
    returned.

Qualifiers:
-------------
IN







Create
public  Create([IN]CIM_Controller Instance, [OUT] REF CIM_Controller ResourceCreated)



  
Permission Information:
No permissions defined

General 
  Information:
Creates a new instance of this class

Product 
  Specific Usage:
The following properties must be included in any 
  representation of CIM_Controller: 

DeviceID 
CreationClassName 
  
SystemName 
SystemCreationClassName 






Put
public  Put([IN]CIM_Controller Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of CIM_Controller: 

DeviceID 
  
CreationClassName 
SystemName 
SystemCreationClassName 







Get
public  Get([OUT]CIM_Controller Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Gets the representation of the instance





Delete
public  Delete()



  
Permission Information:
No permissions defined

General 
  Information:
Deletes an instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context





Subscribe
public  Subscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Subscribes to this resource (WS-Eventing)





Unsubscribe
public  Unsubscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Remove subscription to this resource 
(WS-Eventing)






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.