Share via


CIM_StorageVolume class

A StorageVolume is a StorageExtent that is published for use outside of the scoping System. For SCSI storage target devices, StorageVolumes are used to represent target Block devices, (peripheral device type codes 0h (i.e, direct-access), 4h (i.e., write-once), 5h (i.e., CD/DVD), 7h (i.e., optical memory), and Eh (i.e., simplified direct-access).);

Stream devices, (peripheral device type codes 1h (i.e.,

sequential-access) and 3h (i.e., processor).).

In these case, StorageVolume.Name will be derived from SCSI volume as documented in StorageExtent.Nameformat and NameNamespace Descriptions.

The 'Exported' value from StorageExtent.ExtentStatus[] MUST be in all instances of StorageVolume to maintain the semantic of 'published' described above.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Abstract, Version("2.13.0"), UMLPackagePath("CIM::Device::StorageExtents")]
class CIM_StorageVolume : CIM_StorageExtent
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[];
  uint64   MaxQuiesceTime;
  uint16   DataOrganization;
  string   Purpose;
  uint16   Access;
  string   ErrorMethodology;
  uint64   BlockSize;
  uint64   NumberOfBlocks;
  uint64   ConsumableBlocks;
  boolean  IsBasedOnUnderlyingRedundancy;
  boolean  SequentialAccess;
  uint16   ExtentStatus[];
  boolean  NoSinglePointOfFailure;
  uint16   DataRedundancy;
  uint16   PackageRedundancy;
  uint8    DeltaReservation;
  boolean  Primordial = FALSE;
  string   OtherNameNamespace;
  string   OtherNameFormat;
  string   Name;
  uint16   NameFormat;
  uint16   NameNamespace;
};

Members

The CIM_StorageVolume class has these types of members:

Methods

The CIM_StorageVolume class has these methods.

Method Description
EnableDevice 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.
This method is inherited from CIM_LogicalDevice.
OnlineDevice 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.
This method is inherited from CIM_LogicalDevice.
QuiesceDevice 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.
This method is inherited from CIM_LogicalDevice.
RequestStateChange 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. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
This method is inherited from CIM_EnabledLogicalElement.
Reset 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.
This method is inherited from CIM_LogicalDevice.
RestoreProperties 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.
This method is inherited from CIM_LogicalDevice.
SaveProperties 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.
This method is inherited from CIM_LogicalDevice.
SetPowerState 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.
This method is inherited from CIM_LogicalDevice.

Properties

The CIM_StorageVolume class has these properties.

Access

Data type: uint16

Access type: Read-only

Access describes whether the media is readable (value=1), writeable (value=2), or both (value=3). "Unknown" (0) and "Write Once" (4) can also be defined.

This property is inherited from CIM_StorageExtent.

Unknown (0)

Readable (1)

Writeable (2)

Read/Write Supported (3)

Write Once (4)

AdditionalAvailability

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

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").

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)

Power Save - Low Power Mode (14)

Power Save - Standby (15)

Power Cycle (16)

Power Save - Warning (17)

Paused (18)

Not Ready (19)

Not Configured (20)

Quiesced (21)

Availability

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

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.

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)

Power Save - Low Power Mode (14)

Power Save - Standby (15)

Power Cycle (16)

Power Save - Warning (17)

Paused (18)

Not Ready (19)

Not Configured (20)

Quiesced (21)

BlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes"), MappingStrings ("MIF.DMTF|Host Storage|001.4", "MIB.IETF|HOST-RESOURCES-MIB.hrStorageAllocationUnits", "MIF.DMTF|Storage Devices|001.5")

Size in bytes of the blocks which form this StorageExtent. 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 AggregateExtents, Memory or LogicalDisks), enter a 1.

This property is inherited from CIM_StorageExtent.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

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

This property is inherited from CIM_ManagedElement.

ConsumableBlocks

Data type: uint64

Access type: Read-only

The maximum number of blocks, of size BlockSize, which are available for consumption when layering StorageExtents using the BasedOn association. This property only has meaning when this StorageExtent is an Antecedent reference in a BasedOn relationship. For example, a StorageExtent could be composed of 120 blocks. However, the Extent itself may use 20 blocks for redundancy data. If another StorageExtent is BasedOn this Extent, only 100 blocks would be available to it. This information ('100 blocks is available for consumption') is indicated in the ConsumableBlocks property.

This property is inherited from CIM_StorageExtent.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

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.

This property is inherited from CIM_LogicalDevice.

DataOrganization

Data type: uint16

Access type: Read-only

Type of data organization used.

This property is inherited from CIM_StorageExtent.

Other (0)

Unknown (1)

Fixed Block (2)

Variable Block (3)

Count Key Data (4)

DataRedundancy

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.DataRedundancyGoal", "CIM_StorageSetting.DataRedundancyMax", "CIM_StorageSetting.DataRedundancyMin")

Number of complete copies of data currently maintained.

This property is inherited from CIM_StorageExtent.

DeltaReservation

Data type: uint8

Access type: Read-only

Qualifiers: Units ("Percentage"), MinValue (1), MaxValue (100), ModelCorrespondence ("CIM_StorageSetting.DeltaReservationGoal", "CIM_StorageSetting.DeltaReservationMax", "CIM_StorageSetting.DeltaReservationMin")

Current value for Delta reservation. This is a percentage that specifies the amount of space that should be reserved in a replica for caching changes.

This property is inherited from CIM_StorageExtent.

Description

Data type: string

Access type: Read-only

Contains a textual description of the object.

This property is inherited from CIM_ManagedElement.

DeviceID

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (64)

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

This property is inherited from CIM_LogicalDevice.

ElementName

Data type: string

Access type: Read-only

Contains 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.

This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16

Access type: Read/write

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).

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Not Applicable (5)

Enabled but Offline (6)

No Default (7)

Quiesce (9)

DMTF Reserved

10 32767

Vendor Reserved

32768 65535

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

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.

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

Other (1)

Enabled (2)

Disabled (3)

Shutting Down (4)

Not Applicable (5)

Enabled but Offline (6)

In Test (7)

Deferred (8)

Quiesce (9)

Starting (10)

DMTF Reserved

11 32767

Vendor Reserved

32768 65535

ErrorCleared

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

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

This property is inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.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.

This property is inherited from CIM_LogicalDevice.

ErrorMethodology

Data type: string

Access type: Read-only

ErrorMethodology is a free-form string describing the type of error detection and correction supported by this StorageExtent.

This property is inherited from CIM_StorageExtent.

ExtentStatus

Data type: uint16 array

Access type: Read-only

StorageExtents have additional status information beyond that captured in the OperationalStatus and other properties, inherited from ManagedSystemElement. This additional information (for example, "Protection Disabled", value=9) is captured in the ExtentStatus property. 'In-Band Access Granted' says that access to data on an extent is granted to some consumer and is only valid when 'Exported' is also set. It is set as a side effect of PrivilegeManagementService.ChangeAccess or equivalent interfaces. 'Imported' indicates that the extent is used in the current system, but known to be managed by some other system. For example, a server imports volumes from a disk array. 'Exported' indicates the extent is meant to be used by some comsumer. A disk array's logical units are exported. Intermediate composite extents may be neither imported nor exported.

This property is inherited from CIM_StorageExtent.

Other (0)

Unknown (1)

None/Not Applicable (2)

Broken (3)

Data Lost (4)

Dynamic Reconfig (5)

Exposed (6)

Fractionally Exposed (7)

Partially Exposed (8)

Protection Disabled (9)

Readying (10)

Rebuild (11)

Recalculate (12)

Spare in Use (13)

Verify In Progress (14)

In-Band Access Granted (15)

Imported (16)

Exported (17)

DMTF Reserved

18 32767

Vendor Reserved

32768 65535

HealthState

Data type: uint16

Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its sub-components.

This property is inherited from CIM_ManagedSystemElement.

The following values have been defined:

Unknown (0)

The implementation cannot report on HealthState at this time.

OK (5)

The element is fully functional and is operating within normal operational parameters and without error.

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

Minor failure (15)

All functionality is available but some might be degraded.

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.

Critical failure (25)

The element is non-functional and recovery might not be possible.

Non-recoverable error (30)

The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.

DMTF Reserved

DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

IdentifyingDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

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.

This property is inherited from CIM_LogicalDevice.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

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

This property is inherited from CIM_ManagedSystemElement.

IsBasedOnUnderlyingRedundancy

Data type: boolean

Access type: Read-only

True indicates that the underlying StorageExtent(s) participate in a StorageRedundancyGroup.

This property is inherited from CIM_StorageExtent.

LastErrorCode

Data type: uint32

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

LastErrorCode captures the last error code reported by the LogicalDevice.

This property is inherited from CIM_LogicalDevice.

MaxQuiesceTime

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

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.

This property is inherited from CIM_LogicalDevice.

Name

Data type: string

Access type: Read-only

Qualifiers: Override ("Name"), MappingStrings ("ANSI|T10|SCSI SPC-3|8.6"), ModelCorrespondence ("CIM_StorageVolume.NameFormat")

A unique identifier for the Volume.

NameFormat

Data type: uint16

Access type: Read-only

Qualifiers: Override ("NameFormat")

A subset of StorageExtent name formats apply to StorageVolumes.

Unknown (0)

Other (1)

VPD83NAA6 (2)

VPD83NAA5 (3)

VPD83Type2 (4)

VPD83Type1 (5)

VPD83Type0 (6)

SNVM (7)

NodeWWN (8)

NAA (9)

EUI64 (10)

T10VID (11)

NameNamespace

Data type: uint16

Access type: Read-only

Qualifiers: Override ("NameNamespace")

A subset of StorageExtent name spaces apply to StorageVolume.

Unknown (0)

Other (1)

VPD83Type3 (2)

VPD83Type2 (3)

VPD83Type1 (4)

VPD80 (5)

NodeWWN (6)

SNVM (7)

NoSinglePointOfFailure

Data type: boolean

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.NoSinglePointOfFailure")

Indicates whether or not there exists no single point of failure.

This property is inherited from CIM_StorageExtent.

NumberOfBlocks

Data type: uint64

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Host Storage|001.5", "MIB.IETF|HOST-RESOURCES-MIB.hrStorageSize")

Total number of logically contiguous blocks, of size Block Size, which form this Extent. The total size of the Extent can be calculated by multiplying BlockSize by NumberOfBlocks. If the BlockSize is 1, this property is the total size of the Extent.

This property is inherited from CIM_StorageExtent.

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Contains indicators of the current status of the element. The first value of OperationalStatus should contain the primary status for the element.

Note

OperationalStatus replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, Microsoft strongly recommends that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.

This property is inherited from CIM_ManagedSystemElement.

The following values have been defined:

Unknown (0)

Indicates the implementation cannot report on OperationalStatus at this time.

Other (1)

Indicates an undefined state.

OK (2)

Indicates full functionality without errors.

Degraded (3)

Indicates the element is working 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

Stressed (4)

Indicates that the element is functioning, but needs attention. Overload and overheated are examples of Stressed states.

Predictive Failure (5)

Indicates that an element is functioning nominally but predicting a failure in the near future.

Error (6)

Indicates that an error has occurred.

Non-Recoverable Error (7)

A non-recoverable error has occurred.

Starting (8)

The job is starting.

Stopping (9)

The job is stopping.

Stopped (10)

The element has been intentionally stopped.

In Service (11)

Indicates the element is being configured, maintained, cleaned, or otherwise administered.

No Contact (12)

Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.

Lost Communication (13)

Indicates that the job is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted (14)

Indicates the job stopped in an unexpected way. The state and configuration of the job might need to be updated.

Dormant (15)

Indicates that the job is inactive.

Supporting Entity in Error (16)

Indicates that an element on which this job depends is in error. This element may be OK but is unable to function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

Completed (17)

Indicates that the job has completed its operation. This value should be combined with either OK, ErrorError, 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 (18)

"Power Mode" indicates that the element has additional power model information contained in the associated PowerManagementService association.

DMTF Reserved

DMTF has reserved this portion of the range for additional OperationalStatus values in the future.

Vendor Reserved

Microsoft has reserved the unused portion of the range for additional OperationalStatus values in the future.

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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.

This property is inherited from CIM_EnabledLogicalElement.

OtherIdentifyingInfo

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), MaxLen (256), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

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.

This property is inherited from CIM_LogicalDevice.

OtherNameFormat

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageExtent.NameFormat")

A string describing the format of the Name property when NameFormat includes the value 1, "Other".

This property is inherited from CIM_StorageExtent.

OtherNameNamespace

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageExtent.NameNamespace")

A string describing the namespace of the Name property when NameNamespace includes the value 1, "Other".

This property is inherited from CIM_StorageExtent.

PackageRedundancy

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.PackageRedundancyGoal", "CIM_StorageSetting.PackageRedundancyMax", "CIM_StorageSetting.PackageRedundancyMin")

How many physical packages can currently fail without data loss. For example, in the storage domain, this might be disk spindles.

This property is inherited from CIM_StorageExtent.

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

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.

This property is inherited from CIM_LogicalDevice.

Unknown (0)

Not Supported (1)

Disabled (2)

Enabled (3)

Power Saving Modes Entered Automatically (4)

Power State Settable (5)

Power Cycling Supported (6)

Timed Power On Supported (7)

PowerManagementSupported

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

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 relationship) indicates that power management is supported.

This property is inherited from CIM_LogicalDevice.

PowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Hours"), Counter

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

This property is inherited from CIM_LogicalDevice.

Primordial

Data type: boolean

Access type: Read-only

If true, "Primordial" indicates that the containing System does not have the ability to create or delete this operational element. This is important because StorageExtents are assembled into higher-level abstractions using the BasedOn association. Although the higher-level abstractions can be created and deleted, the most basic, (i.e. primordial), hardware-based storage entities cannot. They are physically realized as part of the System, or are actually managed by some other System and imported as if they were physically realized. In other words, a Primordial StorageExtent exists in, but is not created by its System and conversely a non-Primordial StorageExtent is created in the context of its System. For StorageVolumes, this property will generally be false. One use of this property is to enable algorithms that aggregate StorageExtent.ConsumableSpace across all, StorageExtents but that also want to distinquish the space that underlies Primordial StoragePools. Since implementations are not required to surface all Component StorageExtents of a StoragePool, this information is not accessible in any other way.

This property is inherited from CIM_StorageExtent.

Purpose

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrStorageDescr")

A free form string describing the media and/or its use.

This property is inherited from CIM_StorageExtent.

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

RequestedState is an integer enumeration that indicates the last requested or desired state for the element. 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. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. 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. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Deferred (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved

13 32767

Vendor Reserved

32768 65535

SequentialAccess

Data type: boolean

Access type: Read-only

Boolean set to TRUE if the Storage is sequentially accessed by a MediaAccessDevice. A TapePartition is an example of a sequentially accessed StorageExtent. StorageVolumes, Disk Partitions and LogicalDisks represent randomly accessed Extents.

This property is inherited from CIM_StorageExtent.

Status

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

Contains a string indicating the primary status of the object.

Note

This property is deprecated and replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility it should be secondary to the OperationalStatus property.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

("No Contact")

("Lost Comm")

("Stopped")

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Contains strings describing the corresponding values in the OperationalStatus array. For example, if an element in OperationalStatus contains the value Stopping, then the element at the same array index in this property may contain an explanation as to why an object is being stopped.

This property is inherited from CIM_ManagedSystemElement.

StatusInfo

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

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

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: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The scoping System's CreationClassName.

This property is inherited from CIM_LogicalDevice.

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The scoping System's Name.

This property is inherited from CIM_LogicalDevice.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

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.

This property is inherited from CIM_EnabledLogicalElement.

TotalPowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Hours"), Counter

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

This property is inherited from CIM_LogicalDevice.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012 R2
Namespace
Root\CIMv2\Storage\iScsiTarget
MOF
SmIscsiTarget.mof
DLL
SMiSCSITargetProv.dll

See also

CIM_StorageExtent