CIM_AggregatePSExtent class

Article
01/06/2021

The CIM_AggregatePSExtent class defines the number of addressable logical blocks on a single storage device, excluding logical blocks mapped as check data. If volume sets are defined, the logical blocks are contained within a single volume set. This is an alternative grouping for CIM_ProtectedSpaceExtent, when only summary information is needed or when automatic configuration is used.

Automatic configuration can result in thousands of CIM_ProtectedSpaceExtent classes being defined. The CIM_AggregatePSExtent class was defined so that individual extents would not have to be modeled.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

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

Syntax

[Abstract, UUID("{2D0E255C-E3D1-11d2-8601-0000F8102E5F}"), AMENDMENT]
class CIM_AggregatePSExtent : CIM_StorageExtent
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  uint16   Availability;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   DeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  ErrorCleared;
  string   ErrorDescription;
  uint32   LastErrorCode;
  string   PNPDeviceID;
  boolean  PowerManagementSupported;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
  uint16   Access;
  uint64   BlockSize;
  string   ErrorMethodology;
  uint64   NumberOfBlocks;
  string   Purpose;
};

Members

The CIM_AggregatePSExtent class has these types of members:

Methods
Properties

Methods

The CIM_AggregatePSExtent class has these methods.

Method	Description
Reset	Requests a reset of the logical device. Not implemented by WMI.
SetPowerState	Defines the desired power state for a logical device and when the device should be put into that state. Not implemented by WMI.

Properties

The CIM_AggregatePSExtent class has these properties.

Access

Data type: uint16
Access type: Read-only

Describes the read/write properties of the media.

This property is inherited from CIM_StorageExtent.

Unknown (0)

Readable (1)

Writeable (2)

Read/Write Supported (3)

Write Once (4)

Availability

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|003.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus")

Availability and status of the device.

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Running/Full Power (3)

Warning (4)

In Test (5)

Not Applicable (6)

Power Off (7)

Off Line (8)

Off Duty (9)

Degraded (10)

Not Installed (11)

Install Error (12)

Power Save - Unknown (13)

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

Power Save - Low Power Mode (14)

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

Power Save - Standby (15)

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

Power Cycle (16)

Power Save - Warning (17)

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

Paused (18)

The device is paused.

Not Ready (19)

The device is not ready.

Not Configured (20)

The device is not configured.

Quiesced (21)

The device is quiet.

BlockSize

Data type: uint64
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrStorageAllocationUnits"), Units ("bytes")

Size, in bytes, of the blocks that form the storage extent. If variable block size, then the maximum block size, in bytes, should be specified. If the block size is unknown, or if a block concept is not valid (for example, for aggregate extents, memory, or logical disks), enter a 1 (one).

For more information about using uint64 values in scripts, see Scripting in WMI.

This property is inherited from CIM_StorageExtent.

Caption

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

A short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

ConfigManagerErrorCode

Data type: uint32
Access type: Read-only
Qualifiers: Schema ("Win32")

Win32 Configuration Manager error code.

This property is inherited from CIM_LogicalDevice.

This device is working properly. (0)

This device is not configured correctly. (1)

Windows cannot load the driver for this device. (2)

The driver for this device might be corrupted, or your system may be running low on memory or other resources. (3)

This device is not working properly. One of its drivers or your registry might be corrupted. (4)

The driver for this device needs a resource that Windows cannot manage. (5)

The boot configuration for this device conflicts with other devices. (6)

Cannot filter. (7)

The driver loader for the device is missing. (8)

This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly. (9)

This device cannot start. (10)

This device failed. (11)

This device cannot find enough free resources that it can use. (12)

Windows cannot verify this device's resources. (13)

This device cannot work properly until you restart your computer. (14)

This device is not working properly because there is probably a re-enumeration problem. (15)

Windows cannot identify all the resources this device uses. (16)

This device is asking for an unknown resource type. (17)

Reinstall the drivers for this device. (18)

Failure using the VxD loader. (19)

Your registry might be corrupted. (20)

System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device. (21)

This device is disabled. (22)

System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation. (23)

This device is not present, is not working properly, or does not have all its drivers installed. (24)

Windows is still setting up this device. (25)

Windows is still setting up this device. (26)

This device does not have valid log configuration. (27)

The drivers for this device are not installed. (28)

This device is disabled because the firmware of the device did not give it the required resources. (29)

This device is using an Interrupt Request (IRQ) resource that another device is using. (30)

This device is not working properly because Windows cannot load the drivers required for this device. (31)

ConfigManagerUserConfig

Data type: boolean
Access type: Read-only
Qualifiers: Schema ("Win32")

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: CIM_Key

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

This property is inherited from CIM_LogicalDevice.

Description

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Description")

A textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

DeviceID

Data type: string
Access type: Read-only
Qualifiers: CIM_Key

Address or other identifying information to uniquely name the logical device.

This property is inherited from CIM_LogicalDevice.

ErrorCleared

Data type: boolean
Access type: Read-only

If TRUE, the error reported in the LastErrorCode property is now cleared.

This property is inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string
Access type: Read-only

Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform.

This property is inherited from CIM_LogicalDevice.

ErrorMethodology

Data type: string
Access type: Read-only

Free-form string that describes the type of error detection and correction supported by the storage extent.

This property is inherited from CIM_StorageExtent.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

LastErrorCode

Data type: uint32
Access type: Read-only

Last error code reported by the logical device.

This property is inherited from CIM_LogicalDevice.

Name

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Name")

Label by which the object is known. When subclassed, this property can be overridden to be a key property.

This property is inherited from CIM_ManagedSystemElement.

NumberOfBlocks

Data type: uint64
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrStorageSize")

Number of consecutive blocks, each block the size of the value contained in the BlockSize property, that form the storage extent. Total size of the storage extent can be calculated by multiplying the value of the BlockSize property by the value of this property. If the value of BlockSize is 1 (one), this property is the total size of the storage extent.

For more information about using uint64 values in scripts, see Scripting in WMI.

This property is inherited from CIM_StorageExtent.

PNPDeviceID

Data type: string
Access type: Read-only
Qualifiers: Schema ("Win32")

Indicates the Win32 Plug and Play device identifier of the logical device.

Example: "*PNP030b"

This property is inherited from CIM_LogicalDevice.

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only

Indicates the specific power-related capabilities of the logical device.

This property is inherited from CIM_LogicalDevice.

Unknown (0)

The power-related capacities are unknown.

Not Supported (1)

Power-related capacities are not supported for this device.

Disabled (2)

Power-related capacities have been disabled.

Enabled (3)

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

Power Saving Modes Entered Automatically (4)

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

Power State Settable (5)

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.

Power Cycling Supported (6)

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

Timed Power On Supported (7)

The SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle") and the Time parameter 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, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array.

This property is inherited from CIM_LogicalDevice.

Purpose

Data type: string
Access type: Read-only

Free form string that describes the media and its use.

This property is inherited from CIM_StorageExtent.

Status

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

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

StatusInfo

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|003.3")

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.

Other (1)

Unknown (2)

Enabled (3)

Disabled (4)

Not Applicable (5)

SystemCreationClassName

Data type: string
Access type: Read-only
Qualifiers: Propagated ("CIM_System.CreationClassName"), CIM_Key

The scoping system's creation class name.

This property is inherited from CIM_LogicalDevice.

SystemName

Data type: string
Access type: Read-only
Qualifiers: Propagated ("CIM_System.Name"), CIM_Key

The scoping system's name.

This property is inherited from CIM_LogicalDevice.

Remarks

The CIM_AggregatePSExtent class is derived from CIM_StorageExtent.

WMI does not implement this class.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\CIMV2
MOF	CIMWin32.mof
DLL	CIMWin32.dll

Share via

CIM_AggregatePSExtent class

Syntax

Members

Methods

Properties

Remarks

Requirements

See also

Feedback

Additional resources