Subclass of CIM_StorageExtent
This is generic class describing block devices available on the system, i.e. in machine’s /dev/ directory.
InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following “preferred” algorithm:
Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above “preferred” algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
If not set to null for DMTF-defined instances, the “preferred” algorithm must be used with the <OrgID> set to CIM.
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.
Indicates whether or not there exists no single point of failure.
Name of bus, used to connect the block device, such as USB, SCSI or ATA. This property is available mostly for disk block devices, not for their descendants like partitions, logical volumes and so on. Note that the list of values may not be complete and is not guaranteed to be stable.
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.
Usually it is name of the device, i.e. ‘sda’ in case of /dev/sda block device or ‘myraid’ in case of /dev/md/myraid or name of a Logical Volume. Subclasses may define its own ElementName format.
The preferred source SCSI for volume names is SCSI VPD Page 83 responses. Page 83 returns a list of identifiers for various device elements. The metadata for each identifier includes an Association field, identifiers with association of 0 apply to volumes. Page 83 supports several namespaces specified in the Type field in the identifier metadata. See SCSI SPC-3 specification.
2 = VPD Page 83, Type 3 NAA (NameFormat SHOULD be NAA)
3 = VPD Page 83, Type 2 EUI64 (NameFormat EUI)
4 = VPD Page 83, Type 1 T10 Vendor Identification
Less preferred volume namespaces from other interfaces:
5 = VPD page 80, Serial number (NameFormat SHOULD be Other)
6 = FC NodeWWN (NameFormat SHOULD be NAA or EUI)
7 = Serial Number/Vendor/Model (NameFormat SHOULD be SNVM)
The preferred namespace for LogigicalDisk names is platform specific device namespace; see LogigicalDIsk Description.
8 = OS Device Namespace.
ValueMap Values 0 Unknown 1 Other 2 VPD83Type3 3 VPD83Type2 4 VPD83Type1 5 VPD80 6 NodeWWN 7 SNVM 8 OS Device Namespace
The list here applies to all StorageExtent subclasses. Please look at the Description in each subclass for guidelines on the approriate values for that subclass. Note that any of these formats could apply to a CompositeExtent.
Note - this property originally touched on two concepts that are now separated into this property and NameNamespace. Values 2,3,4,5,6, and 8 are retained for backwards compatibility but are deprecated in lieu of the corresponding values in CIM_StorageExtent.NameNamespace.
For example, the preferred source for SCSI virtual (RAID) disk names is from Inquiry VPD page 83 response, type 3 identifiers. These will have NameFormat set to ‘NAA’ and NameNamespace to ‘VPD83Type3’.
Format of the Name property. Values for extents representing SCSI volumes are (per SCSI SPC-3):
2 = VPD Page 83, NAA IEEE Registered Extended (VPD83NAA6)
3 = VPD Page 83, NAA IEEE Registered (VPD83NAA5)
4 = VPD Page 83, (VPD83Type2) (DEPRECATED)
5 = VPD Page 83,
T10 Vendor Identification (VPD83Type1) (DEPRECATED)
6 = VPD Page 83, Vendor Specific (VPD83Type0) (DEPRECATED)
7 = Serial Number/Vendor/Model (SNVM) SNVM is 3 strings representing the vendor name, product name within the vendor namespace, and the serial number within the model namespace. Strings are delimited with a ‘+’. Spaces may be included and are significant. The serial number is the text representation of the serial number in hexadecimal upper case. This represents the vendor and model ID from SCSI Inquiry data; the vendor field MUST be 8 characters wide and the product field MUST be 16 characters wide. For example,
‘ACME____+SUPER DISK______+124437458’ (_ is a space character)
8 = Node WWN (for single LUN/controller) (NodeWWN)
9 = NAA as a generic format. See
http://standards.ieee.org/regauth/oui/tutorials/fibrecomp_id.html. Formatted as 16 or 32 unseparated uppercase hex characters (2 per binary byte). For example ‘21000020372D3C73’
10 = EUI as a generic format (EUI64) See
Formatted as 16 unseparated uppercase hex characters (2 per binary byte)
11 = T10 vendor identifier format as returned by SCSI Inquiry VPD page 83, identifier type 1. See T10 SPC-3 specification. This is the 8-byte ASCII vendor ID from the T10 registry followed by a vendor specific ASCII identifier; spaces are permitted. For non SCSI volumes, ‘SNVM’ may be the most appropriate choice. 12 = OS Device Name (for LogicalDisks). See LogicalDisk Name description for details.
ValueMap Values 0 Unknown 1 Other 2 VPD83NAA6 3 VPD83NAA5 4 VPD83Type2 5 VPD83Type1 6 VPD83Type0 7 SNVM 8 NodeWWN 9 NAA 10 EUI64 11 T10VID 12 OS Device Name
If not null, then IsComposite shall be true. Number of contiguous underlying StorageExtents counted before looping back to the first underlying StorageExtent of the current stripe. It is the number of StorageExtents forming the user data stripe.
A unique identifier for the Extent.
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.
True indicates that the data is a composition of various StorageExtents that are associated to this StorageExtent via a CIM_BasedOn. Composition models the distribution of user data across one or more underlying StorageExtents, which may or not be protected by some redundancy mechanism. Composite extents represent a contiguous range of logical blocks. Composite extents may overlap, however, the underlying StorageExtents within the overlap shall not contain any check data. Distribution of check data may be specified using the CompositeExtentBasedOn association.
An array of strings used to discriminate the association context in which this StorageExtent is instantiated. Each element of the array should be prefixed by a well known organization name followed by a colon and followed by a string defined by that organization. For example, SNIA SMI-S compliant instances might contain one or more of the following values:
‘SNIA:Pool Component’ - A StorageExtent (or CompositeExtent) that represents storage of a StoragePool and has an AssociatedComponentExtent to its StoragePool, but is not a remaining extent.
‘SNIA:Remaining’ - A StorageExtent that has an AssociatedRemainingExtent to a StoragePool (representing free storage in the StoragePool).
‘SNIA:Intermediate’ - A StorageExtent (or CompositeExtent) that is neither a Pool Component nor a Remaining Extent (it does not represent storage in the pool, remaining or otherwise).
‘SNIA:Composite’ - A StorageExtent that is a CompositeExtent.
‘SNIA:DiskDrive’ - A StorageExtent that is the media on a Disk Drive.
‘SNIA:Imported’ - A StorageExtent that is imported from an external source.
‘SNIA:Allocated’ - A StorageExtent that is subclassed to StorageVolume or LogicalDisk, and has an AllocatedFromStoragePool association from a Concrete StoragePool.
‘SNIA:Shadow’ - A StorageExtent (or subclass) that represents a StorageExtent in another autonomous profile (e.g., the StorageVirtualizer has StorageVolumes (Shadow) that represent StorageVolumes exported by Arrays).
‘SNIA:Spare’ - A StorageExtent that acts as a spare for other StorageExtents (and has the IsSpare association).
‘SNIA:Reserved’ - A StorageExtent that is reserved for some system use within the autonomous profile (e.g., in NAS profiles, an Allocated LogicalDisk is reserved for holding Filesystems).
How many physical packages can currently fail without data loss. For example, in the storage domain, this might be disk spindles.
Number of complete copies of data currently maintained.
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.
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.
ValueMap Values 0 Unknown 1 Other 2 OK 3 Degraded 4 Stressed 5 Predictive Failure 6 Error 7 Non-Recoverable Error 8 Starting 9 Stopping 10 Stopped 11 In Service 12 No Contact 13 Lost Communication 14 Aborted 15 Dormant 16 Supporting Entity in Error 17 Completed 18 Power Mode 19 Relocating DMTF Reserved 0x8000.. Vendor Reserved
All names, under which this device is known. All these names are symlinks to one block device.
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.
‘Relocating’ indicates the extent is being relocated.
ValueMap Values 0 Other 1 Unknown 2 None/Not Applicable 3 Broken 4 Data Lost 5 Dynamic Reconfig 6 Exposed 7 Fractionally Exposed 8 Partially Exposed 9 Protection Disabled 10 Readying 11 Rebuild 12 Recalculate 13 Spare in Use 14 Verify In Progress 15 In-Band Access Granted 16 Imported 17 Exported 18 Relocating DMTF Reserved 32768..65535 Vendor Reserved
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.