Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Win32_UninterruptiblePowerSupply class

[The Win32_UninterruptiblePowerSupplyWMI class is no longer available for use as of Windows Vista because the UPS service is no longer available. This service worked with serially attached UPS devices, not USB devices.]

Represents the capabilities and management capacity of an uninterruptible power supply (UPS).

Windows Server 2003:  This class is available, but not usable because the UPS service fails.

The properties of the UPS device indicate when incoming power is trimmed or boosted, and the aggregated information of the batteries, generators, and so on, that make up the device. These individual components (for example, multiple batteries) can also be independently modeled and associated with the UPS.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class Win32_UninterruptiblePowerSupply : CIM_UninterruptiblePowerSupply
{
  uint16   ActiveInputVoltage;
  uint16   Availability;
  boolean  BatteryInstalled;
  boolean  CanTurnOffRemotely;
  string   Caption;
  string   CommandFile;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   Description;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  uint16   EstimatedChargeRemaining;
  uint32   EstimatedRunTime;
  uint32   FirstMessageDelay;
  datetime InstallDate;
  boolean  IsSwitchingSupply;
  uint32   LastErrorCode;
  boolean  LowBatterySignal;
  uint32   MessageInterval;
  string   Name;
  string   PNPDeviceID;
  boolean  PowerFailSignal;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint32   Range1InputFrequencyHigh;
  uint32   Range1InputFrequencyLow;
  uint32   Range1InputVoltageHigh;
  uint32   Range1InputVoltageLow;
  uint32   Range2InputFrequencyHigh;
  uint32   Range2InputFrequencyLow;
  uint32   Range2InputVoltageHigh;
  uint32   Range2InputVoltageLow;
  uint16   RemainingCapacityStatus;
  string   Status;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
  uint32   TimeOnBackup;
  uint32   TotalOutputPower;
  uint16   TypeOfRangeSwitching;
  string   UPSPort;
};

Members

The Win32_UninterruptiblePowerSupply class has these types of members:

Methods

The Win32_UninterruptiblePowerSupply class has these methods.

MethodDescription
Reset

Not implemented. To implement this method, see the Reset method in CIM_UninterruptiblePowerSupply.

SetPowerState

Not implemented. To implement this method, see the SetPowerState method in CIM_UninterruptiblePowerSupply.

 

Properties

The Win32_UninterruptiblePowerSupply class has these properties.

ActiveInputVoltage
Data type: uint16
Access type: Read-only

Input voltage range currently in use. This property is inherited from CIM_PowerSupply.

ValueMeaning
1

Other

2

Unknown

3

Range 1

4

Range 2

5

Both

6

Neither

 

Availability
Data type: uint16
Access type: Read-only

Availability and status of the device. Inherited from CIM_LogicalDevice.

ValueMeaning
1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Running or Full Power

4 (0x4)

Warning

5 (0x5)

In Test

6 (0x6)

Not Applicable

7 (0x7)

Power Off

8 (0x8)

Offline

9 (0x9)

Off Duty

10 (0xA)

Degraded

11 (0xB)

Not Installed

12 (0xC)

Install Error

13 (0xD)

Power Save - Unknown

The device is known to be in a power save mode, but its exact status is unknown.

14 (0xE)

Power Save - Low Power Mode

The device is in a power save state but still functioning, and may exhibit degraded performance.

15 (0xF)

Power Save - Standby

The device is not functioning, but could be brought to full power quickly.

16 (0x10)

Power Cycle

17 (0x11)

Power Save - Warning

The device is in a warning state, though also in a power save mode.

 

BatteryInstalled
Data type: boolean
Access type: Read-only

If TRUE, a battery is installed on the device.

CanTurnOffRemotely
Data type: boolean
Access type: Read-only

If TRUE, the power supply can be turned off remotely.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Short description of an object—a one-line string. This property is inherited from CIM_ManagedSystemElement.

CommandFile
Data type: string
Access type: Read-only

Name of a command file to execute immediately before shutting down.

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only

Win32 Configuration Manager error code.

ValueMeaning
0 (0x0)

Device is working properly.

1 (0x1)

Device is not configured correctly.

2 (0x2)

Windows cannot load the driver for this device.

3 (0x3)

Driver for this device might be corrupted, or the system may be low on memory or other resources.

4 (0x4)

Device is not working properly. One of its drivers or the registry might be corrupted.

5 (0x5)

Driver for the device requires a resource that Windows cannot manage.

6 (0x6)

Boot configuration for the device conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

Driver loader for the device is missing.

9 (0x9)

Device is not working properly. The controlling firmware is incorrectly reporting the resources for the device.

10 (0xA)

Device cannot start.

11 (0xB)

Device failed.

12 (0xC)

Device cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the device's resources.

14 (0xE)

Device cannot work properly until the computer is restarted.

15 (0xF)

Device is not working properly due to a possible re-enumeration problem.

16 (0x10)

Windows cannot identify all of the resources that the device uses.

17 (0x11)

Device is requesting an unknown resource type.

18 (0x12)

Device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

Registry might be corrupted.

21 (0x15)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.

22 (0x16)

Device is disabled.

23 (0x17)

System failure. If changing the device driver is ineffective, see the hardware documentation.

24 (0x18)

Device is not present, not working properly, or does not have all of its drivers installed.

25 (0x19)

Windows is still setting up the device.

26 (0x1A)

Windows is still setting up the device.

27 (0x1B)

Device does not have valid log configuration.

28 (0x1C)

Device drivers are not installed.

29 (0x1D)

Device is disabled. The device firmware did not provide the required resources.

30 (0x1E)

Device is using an IRQ resource that another device is using.

31 (0x1F)

Device is not working properly. Windows cannot load the required device drivers.

 

ConfigManagerUserConfig
Data type: boolean
Access type: Read-only

If TRUE, the device is using a user-defined configuration. This property is inherited from CIM_LogicalDevice.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Name of the first concrete class to appear in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, this property allows all instances of this class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.

Description
Data type: string
Access type: Read-only

Description of the object. This property is inherited from CIM_ManagedSystemElement.

DeviceID
Data type: string
Access type: Read-only
Qualifiers: Key, Override

Unique identifier of this UPS device with other devices on the system. This property is inherited from CIM_LogicalDevice.

ErrorCleared
Data type: boolean
Access type: Read-only

If TRUE, the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice.

ErrorDescription
Data type: string
Access type: Read-only

Free-form string that supplies more information about the error recorded in LastErrorCode, and information about corrective actions that can be taken. This property is inherited from CIM_LogicalDevice.

EstimatedChargeRemaining
Data type: uint16
Access type: Read-only

Estimate of the percentage of full charge that remains for an UPS that uses battery technology. This property is inherited from CIM_UninterruptiblePowerSupply.

EstimatedRunTime
Data type: uint32
Access type: Read-only

Estimated time, in minutes, until battery or generator depletion in the present load conditions if the utility power is off or lost and remains off. This property is inherited from CIM_UninterruptiblePowerSupply.

FirstMessageDelay
Data type: uint32
Access type: Read-only
Qualifiers: Units (Seconds)

Length of time between initial power failure and the first message sent to users. If power is restored within the FirstMessageDelay value, no message is sent, but the event is logged.

InstallDate
Data type: datetime
Access type: Read-only

Date and time the object is installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

IsSwitchingSupply
Data type: boolean
Access type: Read-only

If TRUE, the power supply is a switching supply—as opposed to linear. This property is inherited from CIM_PowerSupply.

LastErrorCode
Data type: uint32
Access type: Read-only

Last error code the logical device reports. This property is inherited from CIM_LogicalDevice.

LowBatterySignal
Data type: boolean
Access type: Read-only

If TRUE, the power supply has a low-battery signal.

MessageInterval
Data type: uint32
Access type: Read-only
Qualifiers: Units (Seconds)

Length of time between messages sent to users to inform the users of power failure.

Name
Data type: string
Access type: Read-only

Label for the object. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

PNPDeviceID
Data type: string
Access type: Read-only

Plug and Play device identifier of the logical device. This property is inherited from CIM_LogicalDevice.

Example: "*PNP030b"

PowerFailSignal
Data type: boolean
Access type: Read-only

If TRUE, the power supply has a power failure signal.

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only

Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.

ValueMeaning
0 (0x0)

Unknown

1 (0x1)

Not Supported

2 (0x2)

Disabled

3 (0x3)

Enabled

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

4 (0x4)

Power Saving Modes Entered Automatically

The device can change its power state based on usage or other criteria.

5 (0x5)

Power State Settable

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

6 (0x6)

Power Cycling Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).

7 (0x7)

Timed Power-On Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.

 

PowerManagementSupported
Data type: boolean
Access type: Read-only

If TRUE, the device can be power-managed (can be put into suspend mode, and so on). The property does not indicate that power management features are currently enabled, only that the logical device is capable of power management. This property is inherited from CIM_LogicalDevice.

Range1InputFrequencyHigh
Data type: uint32
Access type: Read-only

Frequency, in hertz, at the high end of the power supply input frequency range 1 (one). A value of 0 (zero) indicates DC. This property is inherited from CIM_PowerSupply.

Range1InputFrequencyLow
Data type: uint32
Access type: Read-only

Frequency, in hertz, at the low end of the power supply input frequency range 1 (one). A value of 0 (zero) indicates DC. This property is inherited from CIM_PowerSupply.

Range1InputVoltageHigh
Data type: uint32
Access type: Read-only

Voltage level, in millivolts, above which the UPS must compensate by trimming the voltage. A value of 0 (zero)indicates that the voltage at trimming time is "unknown". This property is inherited from CIM_PowerSupply.

Range1InputVoltageLow
Data type: uint32
Access type: Read-only

Voltage level, in millivolts, below which the UPS must compensate by boosting the voltage using its power source. A value of 0 (zero) indicates that the voltage at boosting time is "unknown". This property is inherited from CIM_PowerSupply.

Range2InputFrequencyHigh
Data type: uint32
Access type: Read-only

Frequency, in hertz, at the high end of the power supply input frequency range 2 (two). A value of 0 (zero) indicates DC. This property is inherited from CIM_PowerSupply.

Range2InputFrequencyLow
Data type: uint32
Access type: Read-only

Frequency, in hertz, at the low end of the power supply input frequency range 2 (two). A value of 0 (zero) indicates DC. This property is inherited from CIM_PowerSupply.

Range2InputVoltageHigh
Data type: uint32
Access type: Read-only

Voltage level, in millivolts, above which the UPS must compensate by trimming the voltage. A value of 0 (zero) indicates that the voltage at trimming time is "unknown". This property is inherited from CIM_PowerSupply.

Range2InputVoltageLow
Data type: uint32
Access type: Read-only

Voltage level, in millivolts, below which the UPS must compensate by using the power source to boost the voltage. A value of 0 (zero) indicates that the voltage at boosting time is "unknown". This property is inherited from CIM_PowerSupply.

RemainingCapacityStatus
Data type: uint16
Access type: Read-only

Capacity remaining in the UPS' batteries and generator. Normal (2) indicates that the remaining estimated minutes of run time is greater than the UPS' defined "low power" state (typically two minutes). Low (3) indicates that the remaining estimated minutes of run-time is less than or equal to the UPS' defined "low power" state. Depleted (4) indicates that the UPS will be unable to sustain the present load when and if the utility power is lost (including the possibility that the utility power is currently absent). This property is inherited from CIM_UninterruptiblePowerSupply.

ValueMeaning
1

Unknown

2

Norma

3

Low

4

Depleted

 

Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, yet the managed element is neither "OK" nor in one of the other states. This property is inherited from CIM_ManagedSystemElement.

The values are:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusInfo
Data type: uint16
Access type: Read-only

State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used. This property is inherited from CIM_LogicalDevice.

ValueMeaning
1

Other

2

Unknown

3

Enabled

4

Disabled

5

Not Applicable

 

SystemCreationClassName
Data type: string
Access type: Read-only

Value of the scoping computer's CreationClassName property. This property is inherited from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only

Name of the scoping system. This property is inherited from CIM_LogicalDevice.

TimeOnBackup
Data type: uint32
Access type: Read-only

Elapsed time, in seconds, after the UPS last switched to battery power, generator, or the time after the UPS was last restarted, whichever is less. If the UPS is "on line", 0 (zero) is returned. This property is inherited from CIM_UninterruptiblePowerSupply.

TotalOutputPower
Data type: uint32
Access type: Read-only

Total output power of the power supply in milliwatts. The value 0 (zero) denotes "unknown". This property is inherited from CIM_PowerSupply.

TypeOfRangeSwitching
Data type: uint16
Access type: Read-only

Type of input voltage range switching implemented in this power supply. This property is inherited from CIM_PowerSupply.

ValueMeaning
1

Other

2

Unknown

3

Manual

4

Autoswitch

5

Wide Range

6

Not Applicable

 

UPSPort
Data type: string
Access type: Read-only

Name of the serial port to which the UPS is connected.

Example: "COM1:"

Remarks

The Win32_UninterruptiblePowerSupply class is derived from CIM_UninterruptiblePowerSupply.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2003

End of client support

None supported

End of server support

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

Computer System Hardware Classes

 

 

Show:
© 2014 Microsoft