RAID Profile 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 25 Document Number: DCIM1031 Document Type: Specification Document Status: Published Document Language: E Date: 2012-03-08 26 Version: 1.2.
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 THIS PROFILE IS FOR INFORMATIONAL PURPOSES ONLY, AND MAY CONTAIN TYPOGRAPHICAL ERRORS AND TECHNICAL INACCURACIES. THE CONTENT IS PROVIDED AS IS, WITHOUT EXPRESS OR IMPLIED WARRANTIES OF ANY KIND.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 CONTENTS 1 2 3 4 5 6 7 8 9 10 11 Scope .................................................................................................................................................... 6 Normative References........................................................................................................................... 6 Terms and Definitions ...................................
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 Table 8 – DCIM_VirtualDiskView - Properties ............................................................................................ 17 Table 9 – DCIM_PhysicalDiskView - Operations ........................................................................................
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 Table 44 – DCIM_RAIDService.GetRAIDLevels () Method: Parameters ................................................... 48 Table 45 –DCIM_RAIDService.GetAvailableDisks() Method: Return Code Values ................................... 48 Table 46 – DCIM_RAIDService.GetAvailableDisks() Method: Standard Messages .....................
RAID Profile 210 211 1 Scope 212 213 214 215 216 The RAID Profile extends the management capabilities of referencing profiles by adding the capability to represent the configuration of RAID storage. The RAID storage is modeled as collections of attributes where there are collections for the storage adaptors, physical disks, logical disks, end enclosures and parent-child relationships between the collections.
246 For the purposes of this document, the following terms and definitions apply. 247 248 249 3.1 Conditional – Indicates requirements to be followed strictly in order to conform to the document when the specified conditions are met. 3.2 250 251 252 Mandatory – Indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted. 253 254 May – Indicates a course of action permissible within the limits of the document.
3.10 269 270 271 shall not – Indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted. 272 273 274 should – Indicates that among several possibilities, one is recommended as particularly suitable, without mentioning or excluding others, or that a certain course of action is preferred but not necessarily required.
308 5 Synopsis 309 Profile Name: RAID Profile 310 Version: 1.2.0 311 Organization: Dell 312 CIM Schema Version: 2.26 Experimental 313 Central Class: DCIM_RAIDService 314 Scoping Class: CIM_ComputerSystem 315 316 317 318 319 The RAID Profile extends the management capability of the referencing profiles by adding the capability to describe the RAID configuration. DCIM_RAIDService shall be the Central Class. CIM_ComputerSystem shall be the Scoping Class.
DCIM_LCRegisteredProfile RegisteredProfile = “Simple RAID” OtherRegisteredOrganization = “DCIM” Interop Namespace Implementation Namespace DCIM_LCElementConformsToProfile DCIM_RAIDService DCIM_EnclosureFanSensor DCIM_ControllerView DCIM_EnclosureTemperatureSensor DCIM_PhysicalDiskView DCIM_ControllerBatteryView DCIM_VirtualDiskView DCIM_EnclosureEMMView DCIM_EnclosureView DCIM_EnclosurePSUView DCIM_RAIDAttribute DCIM_RAIDEnumeration DCIM_RAIDInteger DCIM_RAIDString 331 332 Figure 1 –RAID Pro
334 7 Implementation Description 335 This section describes the requirements and guidelines for implementing RAID profile. 336 337 Table 2 shows the instances of CIM Elements for this profile. Instances of the CIM Elements shall be implemented as described in Table 2. 338 Table 2 – CIM Elements: RAID Profile Element Name Requirement Description DCIM_RAIDService Mandatory See section 7.3 DCIM_ControllerView Mandatory See section 7.1.1 DCIM_EnclosureView Mandatory See section 7.1.
350 351 352 The instance Resource URI for DCIM_ControllerView instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_ControllerView?__cimnamespace=root/dcim+InstanceID=” 353 7.1.1.2 354 The following table lists the implemented operations on DCIM_ControllerView. Operations 355 Table 3 – DCIM_ControllerView - Operations Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 356 7.1.1.
Property Name Requirement Type Additional Requirements PCIVendorID Mandatory string The property shall represent the PCI vendor identifier. PCISubVendorID Mandatory string The property shall represent the PCI sub vendor identifier. PCIDeviceID Mandatory string The property shall represent the PCI device identifier. PCISubDeviceID Mandatory string The property shall represent the PCI sub device identifier.
Property Name Requirement Type Additional Requirements • KeyID Mandatory string 1 - Local Key Management Capable The property shall represent the KeyId of controller when controller is in Local Key Management mode.
369 370 371 The instance Resource URI for DCIM_EnclosureView instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_EnclosureView?__cimnamespace=root/dcim+InstanceID=” 372 7.1.2.2 373 The following table lists the implemented operations on DCIM_EnclosureView. Operations 374 Table 5 – DCIM_EnclosureView - Operations Operation Name Requirements Required Input Get Enumerate Mandatory Mandatory Instance URI Class URI 375 7.1.2.
Property Name Requirement Type Additional Requirements WiredOrder Mandatory Uint8 The property shall represent the connection sequence in a daisy chain of enclosures in the relation to the controller port (0 for backplane). ServiceTag Mandatory string The property shall contain up to 10 characters. AssetTag Mandatory string The property shall contain up to 10 characters. Version Mandatory string The property shall represent the EMM version.
388 389 390 The instance Resource URI for DCIM_VirtualDiskView instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_VirtualDiskView?__cimnamespace=root/dcim+InstanceID=” 391 7.1.3.2 392 The following table details the implemented operations on DCIM_VirtualDiskView. Operations 393 Table 7 – DCIM_VirtualDiskView - Operations Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 394 7.1.3.
Property Name 18 Requirement Type RAIDStatus Mandatory Uint32 WriteCachePolicy Mandatory Uint32 ReadCachePolicy Mandatory Uint32 RAIDTypes Mandatory Uint32 SizeInBytes Mandatory Uint64 Description The property shall represent the RAID specific status and shall have one of the following values: • 0 - Unknown • 1 - Ready • 2 - Online • 3 - Foreign • 4 - Offline • 5 - Blocked • 6 - Failed • 7 – Degraded • 8 – Non-RAID The property shall represent the current write policy and shall be one of
Property Name Requirement Type Description The property shall represent the current strip size and shall be one of the following values: StripeSize Mandatory Uint32 Name Mandatory string SpanLength Mandatory Uint32 SpanDepth Mandatory Uint32 PhysicalDiskIDs[] Mandatory String VirtualDiskTarget ID Mandatory Uint32 RemainingRedundancy Mandatory Uint16 DiskCachePolicy Mandatory Uint32 Version 1.2.
Property Name 20 Requirement Type ObjectStatus Mandatory Uint8 StartingLBAinBlocks Mandatory Uint8 Cachecade Mandatory Uint8 LockStatus Mandatory Uint8 OperationName Mandatory String OperationPercentComplete Mandatory Uint8 BusProtocol Mandatory Uint32 Description The property shall represent the virtual disk configuration state and shall be one of the following values: • 0 – Current • 1 – Pending • 2 – Current Virtual Disk Pending Delete • 3 – Pending Create The property shall repr
Property Name Requirement Type MediaType Mandatory Uint32 LastSystemInventoryTime Mandatory string LastUpdateTime Mandatory string Description The property shall represent the drive media type and shall have one of the following values: • 0 - Unknown • 1 - Magnetic Drive • 2 - Solid State Drive The property shall represent the last time “System Inventory Collection on Reboot (CSIOR)” was performed. The value is represented as "yyyymmddHHMMSS”.
Property Name Requirement Type InstanceID Mandatory string FQDD Mandatory string RAIDStatus Mandatory Uint32 PrimaryStatus Mandatory Uint32 Connector Mandatory Uint16 Slot Mandatory Uint16 SizeInBytes Mandatory Uint64 Model Mandatory string Manufacturer Mandatory string ManufacturingYear Mandatory Uint32 ManufacturingWeek Mandatory Uint16 Description The property shall have the same value as the FQDD property.
Property Name Requirement Type ManufacturingDay Mandatory Uint16 Revision Mandatory string SerialNumber Mandatory string BusProtocol Mandatory Uint32 HotSpareStatus Mandatory Uint16 PredictiveFailureState Mandatory Uint32 SecurityState Mandatory Uint32 MediaType Mandatory Uint32 FreeSizeInBytes Mandatory Uint64 Version 1.2.
Property Name Requirement Type UsedSizeInBytes Mandatory Uint64 MaxCapableSpeed Mandatory Uint32 SASAddress Mandatory string PPID Mandatory String DriveFormFactor Mandatory Uint8 SupportedEncryptionTypes[] Mandatory Stirng OperationName Mandatory String OperationPercentComplete Mandatory Uint8 LastSystemInventoryTime Mandatory string LastUpdateTime Mandatory string Description The property shall represent the space already consumed by virtual disks The property shall rep
419 7.1.5 Controller Battery View - DCIM_ControllerBatteryView 420 421 This section describes the implementation for the DCIM_ControllerBatteryView class. This class shall be instantiated in the Implementation Namespace: root/dcim. 422 7.1.5.1 423 424 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_ControllerBatteryView?__cimnamespace=root/dcim” 425 The key property shall be the InstanceID.
Property Name Requirement PredictiveCapacity Mandatory Type Uint32 Additional Requirements • 7 - Degraded • 9 - Missing • 10 - Charging • 12 - Below Threshold The property shall be following values: 0 – Unknown 1 – Ready 6 - Failed 438 7.1.6 Enclosure Mangement Module View - DCIM_EnclosureEMMView 439 440 This section describes the implementation for the DCIM_EnclosureEMMView class. This class shall be instantiated in the Implementation Namespace: root/dcim. 441 7.1.6.
Property Name Requirement Type Additional Requirements one of the following values: • 0 - Unknown • 1 - OK • 2 - Degraded • 3 - Error PartNumber Mandatory String The property shall represent the EMM part number. Revision Mandatory String The property shall represent the version of the EMM firmware. 457 7.1.7 Enclosure Power Supply Unit View - DCIM_EnclosurePSUView 458 459 This section describes the implementation for the DCIM_EnclosurePSUView class.
Property Name Requirement Type Additional Requirements The property shall represent the status of the device and shall be one of the following values: PrimaryStatus Mandatory PartNumber Mandatory uint32 String • 0 - Unknown • 1 - OK • 2 - Degraded • 3 - Error The property shall represent the enclosure power supply unit part number. 477 478 479 7.1.8 Enclosure Fan Sensor - DCIM_EnclosureFanSensor 480 481 This section describes the implementation for the DCIM_EnclosureFanSensor class.
500 Table 18– DCIM_EnclosureFanSensor - Properties Property Name Requirement Type Additional Requirements SystemCreationClassName Mandatory String The property value shall be “DCIM_ComputerSytem”. SystemName Mandatory String The property value shall be “DCIM:ComputerSystem” CreationClassName Mandatory String The property value shall be “DCIM_EnclosureFanSensor” DeviceID Mandatory String The property shall have the sensor FQDD value.
502 7.1.9 Enclosure Temperature Sensor - DCIM_EnclosureTemperatureSensor 503 504 This section describes the implementation for the DCIM_Enclosure Temperature Sensor class. This class shall be instantiated in the Implementation Namespace: root/dcim. 505 7.1.9.1 506 507 The class Resource URI shall be “http://schemas.dell.
Property Name Requirement Type Additional Requirements shall be in Degrees C. ElementName Mandatory string The property shall describe the sensor location. The property shall represent the status of the device and shall be one of the following values: • 0 - Unknown • 1 - OK • 2 - Degraded • 3 - Error PrimaryStatus Mandatory uint32 RateUnits Mandatory uint16 The property value shall be 0 (None). SensorType Mandatory Uint16 The property value shall be 2 (Temperature).
529 530 property correlates all the attributes to a device instance. Attributes can be set using the SetAttribute() method. 531 532 NOTE: The RAIDdefaultWritePolicy, RAIDdefaultReadPolicy, and DiskCachePolicy attributes are not applicable for Cachecade Virtual Disk. 533 7.2.1 534 This section describes the implementation for the DCIM_RAIDEnumeration class.
555 556 557 Table 12 – Class: DCIM_RAIDEnumeration Property Name Requirement Type Additional Requirements InstanceID Mandatory string The property value shall be formed as follows: “:”. AttributeName Mandatory string The property value shall be from the “AttributeName” column in Table 13. CurrentValue[] Mandatory string The property value shall be one of the values in the “PossibleValues” column at the corresponding row in Table 13.
AttributeName Description IsReadOnly Display Order PossibleValue RAIDdefaultWritePolicy1 Desired write policy of the virtual disk. FALSE 304 WriteThrough, WriteBack, WriteBackForce RAIDdefaultReadPolicy1 Desired read polcy of the virtual disk FALSE 303 NoReadAhead, ReadAhead, Adaptive DiskCachePolicy1 Disk cache policy for all member disks. This attribute relates to the virtual disk device. FALSE 301 Default, Enabled, Disabled RAIDPDState Physical Disk state.
Operation Name DCIM_RAIDService.SetAttributes() Requirements Mandatory Required Input See section 8.15. 577 7.2.2.3 Class Properties 578 579 580 The following table lists the implemented properties for DCIM_RAIDString instance representing a RAID string attribute. The “Additional Requirements” column shall denote either possible values for the property, or requirements on the value formulation.
591 This class shall be instantiated in the Implementation Namespace: root/dcim. 592 7.2.3.1 593 594 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_RAIDInteger?__cimnamespace=root/dcim” 595 The key property shall be the InstanceID. 596 597 598 The instance Resource URI for DCIM_RAIDInteger instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_RAIDInteger?__cimnamespace=root/dcim+InstanceID= :” 599 7.2.3.
608 609 Property Name Requirements Type Additional Requirements InstanceID Mandatory string The property value shall be formed as follows: “:”. AttributeName Mandatory string The property value shall be from the “AttributeName” column in Table 18. CurrentValue[] Mandatory string The property value shall be equal or greater than the value in the “LowerBound”column and equal or less than the value in the “UpperBound” column in Table 18.
AttributeName Description IsReadOnly Display Order LowerBound UpperBound RAIDbgiRate1 Background initialization rate of the controller. The attribute is related to the controller device. FALSE 102 1 100 RAIDprRate1 Patrol read rate of the controller. The attribute is related to the controller device. TRUE 112 1 100 RAIDspinDownIdleTime Spin down idle time of the controller.
Operation Name Requirements Required Input Enumerate Invoke Mandatory Mandatory Class URI Instance URI 634 635 7.3.3 Class Properties 636 637 638 639 The following table lists the implemented properties for DCIM_RAIDService instance representing a storage service in a system. The “Requirements” column shall denote whether the property is implemented (for requirement definitions, see section 3).
658 7.4.3 Class Properties 659 660 661 662 The following table lists the implemented properties for DCIM_LCRegisteredProfile instance representing RAID Profile implementation. The “Requirements” column shall denote whether the property is implemented (for requirement definitions, see section 3). The “Additional Requirements” column shall denote either possible values for the property, or requirements on the value formulation.
670 Table 23 –DCIM_RAIDService.AssignSpare() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 671 672 Table 24 – DCIM_RAIDService.
679 Table 26 – DCIM_RAIDService.ResetConfig() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 680 Table 27 – DCIM_RAIDService.ResetConfig( ) Method: Standard Messages MessageID (OUT parameter) Message STOR003 Missing parameter STOR004 Invalid parameter value STOR006 General failure STOR007 Resource Allocation Failure 681 Table 28 – DCIM_RAIDService.
688 Table 31 – DCIM_RAIDService.ClearForeignConfig() Method: Parameters Qualifiers Name Type Description/Values IN, REQ OUT Target RebootRequired String string OUT MessageID string FQDD of target device (Controller) A value of “Yes” means a reboot is required to set this value, and a value of “No” means a reboot is not required to set this value Error MessageID is returned If the method fails to execute.
Qualifiers Name Type Description/Values OUT MessageArguments[] string Substitution messages variables for dynamic error 698 699 8.5 DCIM_RAIDService.CreateVirtualDisk() 700 The CreateVirtualDisk() method is used to create a single virtual disk on the targeted controller. 701 702 703 704 The successful execution of this method results in a pending and unfinished creation of a virtual disk. The ObjectStatus property in the Virtual Disk view class has the value “PendingCreate”.
719 Table 36 – DCIM_RAIDService.CreateVirtualDisk() Method: VDProp VDPropNameArray Name Requirement Additional Requirements Size Optional Size (in MB) of the virtual disk. RAIDLevel Mandatory The new RAID level such as 0, 1, 5, or 6 SpanDepth Mandatory onlyfor multispan Number of spans in virtual disk. SpanLength Mandatory only for multispan Number of disks per span. StripeSize Optional See DCIM_VirtualDiskView class (see section 7.1.3).
MessageID (OUT parameter) Message STOR044 All Physical Disks specfied are not part of the same disk group STOR045 Physical Disks have holes, StartingLBA and Size parameters are required to create a Virtual Disk STOR046 Invalid StartingLBA and/or Size STOR051 StartingLBA and Size combination goes beyond Physical Disk size STOR052 Unsupported number of Virtual Disks on a controller or disk group STOR054 Controller is not cachecade capable. 723 724 Table 39 – DCIM_RAIDService.
731 Table 40 – DCIM_RAIDService.GetDHSDisks () Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 732 Table 41 – DCIM_RAIDService.GetDHSDisks() Method: Standard Messages MessageID (OUT parameter) Message STOR003 Missing parameter STOR004 Invalid parameter value STOR006 General failure STOR007 Resource Allocation Failure Virtual Disk provided is not valid for the operation STOR017 733 Table 42 – DCIM_RAIDService.
740 Table 44 – DCIM_RAIDService.
746 Table 47 – DCIM_RAIDService.
Starting logical block address of virtual disks in 512 byte blocks. If input value is 0xFFFFFFFFFFFFFFFF or 18446744073709551615, startingLBA is calculated programmatically. StartingLBA 758 759 Table 49 – DCIM_RAIDService.CheckVDValues() Method: VDPropNameArrayOut values Description SizeInBytes If Input Parameter “Size” is not specified or is specified as zero, then “SizeInBytes” returns the maximum allowed size of the virtual disk.
MessageID (OUT parameter) Message STOR035 Not enough Storage objects or Storage objects in incorrect state for this operation STOR043 Physical Disk is part of Virtual Disk that is not Secondary Raid Level 0 STOR044 All Physical Disks specfied are not part of the same disk group STOR045 Physical Disks have holes, StartingLBA and Size parameters are required to create a Virtual Disk STOR046 Invalid StartingLBA and/or Size STOR051 StartingLBA and Size combination goes beyond Physical Disk size ST
768 Table 53 –DCIM_RAIDService.SetControllerKey() Method: Return Code Values 769 Value Description 0 Request was successfully executed. 2 Error occurred Table 54 –DCIM_RAIDService.
772 8.11 DCIM_RAIDService.LockVirtualDisk () 773 The LockVirtualDisk() method encrypts the virtual disk. 774 Table 56 – DCIM_RAIDService.LockVirtualDisk() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 775 Table 57 – DCIM_RAIDService.
Qualifiers Name Type Description/Values IN RebootJobType uint16 Creates a specific reboot job to power cycle the host system. This parameter only creates the RebootJob and does not schedule it. Shall contain the requested reboot type: 1 - PowerCycle 2 - Graceful Reboot without forced shutdown 3 - Graceful Reboot with forced shutdown. NOTE: This parameter only creates the RebootJob and does not schedule it. Schedules the configuration job and the optional reboot job at the specified start time.
791 Table 61 – DCIM_RAIDService.
Qualifiers Name Type Description/Values OUT MessageArguments[] String Substitution variables for dynamic error messages 803 804 8.14 DCIM_RAIDService.SetAttribute( ) 805 The SetAttribute( ) method is used to set or change the value of a RAID attribute.
Qualifiers Name Type Description/Values OUT SetResult[] String Returns: • "Set CurrentValue” when the attribute’s current value is set. • “Set PendingValue” when the attribute’s pending value is set. IN, REQ AttributeValue[ ] String OUT RebootRequired [] String OUT MessageID[] String Shall contain a new value to assign to the specified attribute.
MessageID(OUT parameter) Message STOR041 Invalid Attribute Value for Attribute Name STOR042 Unsupported Attribute Value for Attribute Name STOR047 AttributeValue cannot be changed for ReadOnly Attribute Name 834 Table 70 – DCIM_RAIDService.
841 MessageID(OUT parameter) Message STOR021 Controller Key is not present STOR022 Controller is not security capable Table 73 – DCIM_RAIDService.
Qualifiers Name Type Description/Values IN Key String Key is the passcode. This parameter is required if the mode is set to Local Key Management. The Key shall be maximum of 32 characters in length, where the expanded form of the special character is counted as a single character. The Key shall have one character from each of the following set. • Upper Case • Lower Case • Number • Special Character. The special characters in the following set need to be passed as mentioned below.
MessageID(OUT parameter) Message STOR0019 Provided passphrase is not valid STOR048 Controller is not Dell Key Management capable STOR050 Controller is in Dell Key Management mode STOR053 Controller key not present, controller needs key from Dell Key Management Server STOR038 Invalid parameter value for Keyid STOR020 Controller Key is already present 855 Table 79 – DCIM_RAIDService.
857 8.19 DCIM_RAIDService.UnassignSpare() 858 859 860 The UnassignSpare() method is used to unassign a physical disk as a dedicated hot spare from a virtual disk, or as a global hot spare. After the method executes successfully the physical disk shall be available for use. 861 Table 80 – DCIM_RAIDService.UnassignSpare() Method: Return Code Values 862 Value Description 0 Request was successfully executed. 2 Error occurred Table 81 – DCIM_RAIDService.
870 Table 83 – DCIM_RAIDService.ConvertToRAID() Method: Return Code Values 871 Value Description 0 Request was successfully executed. 2 Error occurred Table 84 – DCIM_RAIDService.ConvertToRAID() Method: Standard Messages 872 MessageID(OUT parameter) Message STOR003 Missing parameter STOR004 Invalid parameter value STOR006 General failure Table 85 – DCIM_RAIDService.
Qualifiers OUT Name RebootRequired Type Uint8 Description/Values This parameter shall indicate if reboot is required to set the value and shall be one of the following values: • 0 – No • 1 – Yes Error MessageID is returned If the method fails to execute. OUT MessageID[] String OUT Message[] String Error Message in English corresponding to MessageID is returned If the method fails to execute.
Class and Method Operation INVOKE System Control Login, System Control Login, System Control INVOKE Login INVOKE INVOKE Login Login INVOKE Login Login, System Control Login, System Control Login, System Control Login, System Control Login, System Control Login, System Control Login, System Control Login, System Control Login, System Control Login, System Control Login, System Control Login, System Control Login Login DCIM_RAIDService. CreateVirtualDisk() INVOKE DCIM_RAIDService.