BlockServices
Class IBMTSSVC_BackendVolume


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_LogicalDevice
        \_CIM_StorageExtent


Description

A BackendVolume is a SCSI LUN which is exposed on the fabric by a Storage Controller (typically a RAID array) to the SAN Volume Controller.

Subclasses


Referenced By

IBMTSSVC_BackendControllerForVolume IBMTSSVC_LogicalIdentity IBMTSSVC_MirrorExtentBasedOn IBMTSSVC_PrimordialPoolComponent IBMTSSVC_ProtocolControllerAccessUnit IBMTSSVC_SCSIInitiatorTargetLogicalUnitPath IBMTSSVC_StorageConfigurationService IBMTSSVC_StorageExtentOnCluster IBMTSSVC_StoragePoolComponent IBMTSSVC_VolumeBasedOn

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
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.
DeviceID string
Max Length64
The ID of the BackendVolume. A numerical value which is unique inside the BackendVolume class only.
SystemCreationClassName string
Max Length256
The CreationClassName of the scoping system.
SystemName string
Max Length256
The System Name of the scoping system.
Read Only
Access uint16
Unknown0
Readable1
Writeable2
Read/Write Supported3
Write Once4
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.
ActiveWWPN string
The name of the volume's active WWPN.
AdditionalAvailability uint16
Other1
Unknown2
Running/Full Power3
Warning4
In Test5
Not Applicable6
Power Off7
Off Line8
Off Duty9
Degraded10
Not Installed11
Install Error12
Power Save - Unknown13
Power Save - Low Power Mode14
Power Save - Standby15
Power Cycle16
Power Save - Warning17
Paused18
Not Ready19
Not Configured20
Quiesced21
Additional availability and status of the Device in addition to that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this property 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, the primary Availability of a device might be"Off line"(value=8) or in a low-power state (AdditionalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5,"In Test").
BlockSize uint64
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.
Capacity uint64
The total capacity of the BackendVolume.
ConsumableBlocks uint64
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.
ControllerName string
The name of the volume's back-end controller.
DataOrganization uint16
Other0
Unknown1
Fixed Block2
Variable Block3
Count Key Data4
Type of data organization used.
DataRedundancy uint16
Number of complete copies of data currently maintained.
DeltaReservation uint8
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.
Description string
The Description property provides a textual description of the object.
EnabledDefault uint16
Enabled2
Disabled3
Not Applicable5
Enabled but Offline6
No Default7
DMTF Reserved8..32767
Vendor Reserved32768..65535
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).
EnabledState uint16
Unknown0
Other1
Enabled2
Disabled3
Shutting Down4
Not Applicable5
Enabled but Offline6
In Test7
Deferred8
Quiesce9
Starting10
DMTF Reserved11..32767
Vendor Reserved32768..65535
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 running commands, will process any queued commands, and queues new requests.Disabled (3) indicates that the element will not run 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. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued.Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
ErrorMethodology string
ErrorMethodology is a free-form string describing the type of error detection and correction supported by this StorageExtent.
ExtentStatus uint16
Other0
Unknown1
None/Not Applicable2
Broken3
Data Lost4
Dynamic Reconfig5
Exposed6
Fractionally Exposed7
Partially Exposed8
Protection Disabled9
Readying10
Rebuild11
Recalculate12
Spare in Use13
Verify In Progress14
In-Band Access Granted15
Imported16
Exported17
DMTF Reserved18..32767
Vendor Reserved32768..65535
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.
IdentifyingDescriptions string
An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.
IsBasedOnUnderlyingRedundancy boolean
True indicates that the underlying StorageExtent(s) participate in a StorageRedundancyGroup.
MaxPathCount uint32
The maximum FC path count to the BackendVolume.
Mode uint32
Unmanaged0
Router restricted1
Managed2
Image3
for future use4
for future use5
Router config6
Remote copy7
for future use8
The mode of the BackendVolume.
Name string
Max Length1024
The label by which the object is known.
NativeStatus uint16
Offline0
Online1
Degraded2
Excluded3
The back-end volume's native operational status. Can be either0 ("Offline"),1 ("Online",2 ("Degraded"or3 ("Excluded")
NoSinglePointOfFailure boolean
Indicates whether or not there exists no single point of failure.
NumberOfBlocks uint64
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.
OperationalStatus uint16
Unknown0
Other1
OK2
Degraded3
Stressed4
Predictive Failure5
Error6
Non-Recoverable Error7
Starting8
Stopping9
Stopped10
In Service11
No Contact12
Lost Communication13
Aborted14
Dormant15
Supporting Entity in Error16
Completed17
Power Mode18
DMTF Reserved..
Vendor Reserved0x8000..
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.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.
OtherEnabledState string
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.
OtherIdentifyingInfo string
Max Length256
OtherIdentifyingInfo captures data, in addition to DeviceID information, that could be used to identify a LogicalDevice. For example, you could use this property to hold the operating system's user-friendly name for the Device.
PackageRedundancy uint16
How many physical packages can currently fail without data loss. For example, in the storage domain, this might be disk spindles.
PathCount uint32
The current FC path count to the BackendVolume.
PoolID string
The ID of the associated storage pool.
Poolname string
The name of the associated storage pool.
PreferredWWPN string
The name of the volume's preferred WWPN.
Primordial boolean
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, (that is, 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.
Purpose string
A free form string describing the media and/or its use.
QuorumIndex uint8
The quorum index of the BackendVolume. Valid indices are 0, 1, 2. An index of 3 indicates that this volume isn't usedas quorum disk.
RequestedState uint16
Enabled2
Disabled3
Shut Down4
No Change5
Offline6
Test7
Deferred8
Quiesce9
Reboot10
Reset11
Not Applicable12
DMTF Reserved..
Vendor Reserved32768..65535
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. 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.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". 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 run 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.
SequentialAccess boolean
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.
StatusDescriptions string
Strings describing the various OperationalStatus array values. For example, if"Stopping"is the value assigned to OperationalStatus, then this property would contain an explanation as to why an object is being stopped. Entries in this array are correlated with those at the same array index in OperationalStatus.
UniqueID string
The SCSI VPD information for this volume. Not available for SVC Clusters running pre v4.2.0 Firmware.
Read Write
Caption string
Max Length64
The Caption property is a short textual description (one-line string) of the object.
ElementName string
Max Length15
The BackendVolume's user-friendly name.
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_EnabledLogicalElement
EnabledState, OtherEnabledState, RequestedState, TimeOfLastStateChange, EnabledDefault
 
Inherited from class CIM_LogicalDevice
AdditionalAvailability, Availability, ErrorCleared, ErrorDescription, IdentifyingDescriptions, LastErrorCode, MaxQuiesceTime, OtherIdentifyingInfo, PowerManagementCapabilities, PowerManagementSupported, PowerOnHours, StatusInfo, TotalPowerOnHours
 
Inherited from class CIM_StorageExtent
Access, BlockSize, ConsumableBlocks, DataOrganization, DataRedundancy, DeltaReservation, ErrorMethodology, ExtentStatus, IsBasedOnUnderlyingRedundancy, NoSinglePointOfFailure, NumberOfBlocks, PackageRedundancy, Primordial, Purpose, SequentialAccess
 

Method Summary

NameDescription
GetFreeExtentsThis method can be used to retrieve how much free extents are available on this BackendVolume.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_LogicalDevice
EnableDevice, OnlineDevice, QuiesceDevice, Reset, RestoreProperties, SaveProperties, SetPowerState
 

Method Detail


GetFreeExtents

Description

This method can be used to retrieve how much free extents are available on this BackendVolume.

Parameters

IdTypeRangeDescription
In
FreeExtents uint64
The free extents, which are available.
out
FreeExtents uint64
The free extents, which are available.
Return Codes
none