Fiber Channel Profile 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 Document Number: DCIM1056 Document Type: Specification Document Status: Published Document Language: E 25 Date: 2013-09-06 26 Version: 1.0.
31
2 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. ABSENT A SEPARATE AGREEMENT BETWEEN YOU AND DELL™ WITH REGARD TO FEEDBACK TO DELL ON THIS PROFILE SPECIFICATION, YOU AGREE ANY FEEDBACK YOU PROVIDE TO DELL REGARDING THIS PROFILE SPECIFICATION WILL BE OWNED AND CAN BE FREELY USED BY DELL.
2 Version 1.0.
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 CONTENTS 1 2 3 4 5 6 Scope .................................................................................................................................................... 5 Normative References ........................................................................................................................... 5 Terms and Definitions ............................................................................
Version 1.0.
96 Figures 97 98 Figure 1 – Fiber Channel Profile: Class Diagram ....................................................................................... 99 Tables 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 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 Table 1 – Related Profiles ...........................................................................................................................
4 Version 1.0.
Fiber Channel Profile 141 142 1 Scope 143 144 145 146 The Fiber Channel Profile extends the management capabilities of referencing profiles by adding the capability to represent the configuration of fiber channel host bus adapters (FC HBA). The FC HBAs are modeled as views and attributes where there is a view for each individual controller and multiple attributes that allow FC HBA configuration. 147 2 Normative References 148 Refer to the following documents for more information.
177 o Version 1.0.1 DCIM_LCElementConformsToProfile.
178 179 o DCIM_LCRegisteredProfile.
6 Version 1.0.
180 3 Terms and Definitions 181 For the purposes of this document, the following terms and definitions apply. 182 183 3.1 184 185 3.2 186 187 188 3.3 189 190 191 3.4 192 193 3.5 194 195 3.6 196 197 3.7 198 199 200 3.8 201 202 203 3.9 204 205 206 3.10 207 208 209 3.11 210 211 3.12 can - Used for statements of possibility and capability, whether material, physical, or causal. cannot - Used for statements of possibility and capability, whether material, physical, or causal.
Version 1.0.
212 213 3.13 214 215 Interop Namespace: root/interop is where instrumentation instantiates classes to advertise its capabilities for client discovery. 216 217 3.14 218 219 Implementation Namespace: root/dcim is where instrumentation instantiates classes relevant to executing core management tasks. 220 221 222 3.15 ENUMERATE - 223 3.16 224 225 GET - Interop Namespace: root/interop Implementation Namespace: root/dcim Refers to WS-MAN ENUMERATE operation as described in Section 8.
8 Version 1.0.
226 4 Symbols and Abbreviated Terms 227 228 4.1 229 230 231 4.2 232 233 4.3 234 235 236 4.4 237 238 4.5 239 240 4.6 241 242 4.7 243 244 4.8 245 246 4.9 247 248 4.
Version 1.0.
251 5 Synopsis 252 Profile Name: Fiber Channel 253 Version: 1.0.1 254 Organization: Dell Inc. 255 CIM Schema Version: 2.26 Experimental 256 Central Class: DCIM_FCService 257 Scoping Class: CIM_ComputerSystem 258 259 260 261 The Fiber Channel Profile extends the management capability of the referencing profiles by adding the capability to describe fibre channel (FC) controllers in a simple way.
283 The Fiber Channel Profile information is represented with the instance of CIM_RegisteredProfile. 10 Version 1.0.
DCIM_LCRegisteredProfile RegisteredProfile = “Fiber Channel” OtherRegisteredOrganization = “DCIM” Interop Namespace Implementation Namespace DCIM_LCElementConformsToProfile DCIM_FCService DCIM_FCView DCIM_FCCapabilities DCIM_FCStatistics CIM_BIOSAttribute DCIM_FCAttribute DCIM_FCEnumeration DCIM_FCInteger DCIM_FCString 284 Figure 1 – Fiber Channel Profile: Class Diagram 285 286 6.
Version 1.0.
296 Table 2 - FC HBA FQDD examples FQDD FC.Slot.3-2 Friendly Name FC HBA in Slot 3 Port 2 FC.Mezzanine.1B-1 FC HBA in Mezzanine 1 Port 1 297 298 6.2 Virtual Address attributes 299 300 301 Virtual address attributes include the following attributes: Virtual World Wide Node Name (VirtualWWN) Virtual World Wide Port Name (VirtualWWPN) 302 303 The default values of these virtual attributes is equal to the permanent addresses programmed onto the controller.
12 Version 1.0.
Table 3 – CIM Elements: Fiber Channel Profile 325 Element Name Classes Requirement Description DCIM_FCService Mandatory The class maybe implemented in the Implementation Namespace: root/dcim. See sections 7.8 DCIM_FCView Mandatory The class shall be implemented in the Implementation Namespace: root/dcim. See section 7.1 DCIM_FCCapabilities Mandatory DCIM_FCStatistics Mandatory The class shall be implemented in the Implementation Namespace: root/dcim. See section 7.
Version 1.0.
337 7.1.2 Operations 338 The following table lists the implemented operations on DCIM_FCView. Table 4 – DCIM_FCView - Operations 339 Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 340 7.1.3 Class Properties 341 342 343 344 The following table details the implemented properties for DCIM_FCView instance representing a FC HBA in a system.
14 Version 1.0.
Property Name Requirement Type Requirement and description This property represents the frame payload size. FramePayloadSize Mandatory String FirstFCTargetLUN Mandatory Uint16 Function Mandatory Uint32 HardZoneAddress Mandatory Uint32 This property represents the First FC Target LUN This property represents the function number of the PCI device. This property represents the Hard Zone Address. HardZoneEnable Mandatory Uint8 This property represents the Hard Zone Enable.
Version 1.0.
Property Name Requirement Mandatory VendorName Type String VirtualWWN Mandatory VirtualWWPN WWN Mandatory Mandatory String This property represents the Virtual World Wide Name String String This property represents the Virtual World Wide Port Name. This property represents the World Wide Name. String This property represents the World Wide Port Name. WWPN Mandatory Requirement and description This property represents the Vendor Name. FC HBA Capabilities – DCIM_FCCapabilities 346 7.
16 Version 1.0.
Property Name FCMaxIOsPerSession Requirement Type Mandatory uint16 Requirement and description This property represents the maximum number of I/Os per connection FCMaxNumberLogins Mandatory uint16 This property represents the maximum number of logins per port FCMaxNumberExchanges Mandatory uint16 This property represents the maximum number of exchanges FCMaxNPIVPerPort Mandatory uint16 This property represents the maximum NPIV per port FCMaxNumberOfFCTargets Mandatory uint16 This property
Version 1.0.
373 374 375 The instance Resource URI for DCIM_FCStatistics instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_FCStatistics?__cimnamespace=root/dcim+InstanceID=” 376 7.3.2 Operations 377 The following table lists the implemented operations on DCIM_FCStatistics. Table 8 – DCIM_FCStatistics - Operations 378 Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 379 7.3.
18 Version 1.0.
Property Name OSDriverState 385 Requirement Mandatory Type uint8 Requirement and description This property represents OS driver state 0 – Unknown 1 – Other 2 – Not Applicable 3 – Operational 4 – Non-operational
Version 1.0.
386 7.4 DCIM_FCEnumeration 387 This section describes the implementation for the DCIM_FCEnumeration class. 388 Each DCIM_FCEnumeration instance is logically associated to a DCIM_FCView instance. 389 This class shall be instantiated in the Implementation Namespace:root/dcim. 390 7.4.1 Resource URIs for WinRM 391 392 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_FCEnumeration?__cimnamespace=root/dcim” 393 The key property shall be the InstanceID.
20 Version 1.0.
Table 11 – Class: DCIM_FCEnumeration 406 Properties InstanceID Type String Notes Mandatory Additional Requirements The property value shall be formed as follows: “:”. AttributeName String Mandatory The property value shall be from the “AttributeName” column in Tables in section 7.7. AttributeDisplayName String Mandatory The property value shall be NULL.
Version 1.0.
Table 12 – DCIM_FCString - Operations 422 Operation Name Get Enumerate DCIM_FCService.SetAttributte() DCIM_FCService.SetAttributes() Requirements Mandatory Mandatory Mandatory Mandatory Required Input Instance URI Class URI See section 8.1 See section 8.2 423 424 7.5.3 Class Properties 425 426 427 428 The following table details the implemented properties for DCIM_FCString instance representing a FC HBA string attribute.
22 Version 1.0.
Table 13 – Class: DCIM_FCString 429 Properties InstanceID Type String Notes Mandatory Additional Requirements The property value shall be formed as follows: “:”. AttributeName String Mandatory The property value shall be from the “AttributeName” column in Tables in section 7.7. AttributeDisplayName String Mandatory The property value shall be NULL.
Version 1.0.
440 441 442 The instance Resource URI for DCIM_FCInteger instance shall be: http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_FCInteger?__cimnamespace=root/dcim+InstanceID= : 443 where is the FQDD property value, and is the AttributeName property value. 444 7.6.2 Operations 445 The following table lists the implemented operations on DCIM_FCInteger. Table 14 – DCIM_FCInteger - Operations 446 Operation Name Get Enumerate DCIM_FCService.
24 Version 1.0.
Table 15 – Class: DCIM_FCInteger 453 Properties InstanceID Type String Requirement Mandatory Additional Requirements The property value shall be formed as follows: “:”. AttributeName String Mandatory The property value shall be from the “AttributeName” column in Tables in section 7.7. AttributeDisplayName String Mandatory The property value shall be NULL.
Version 1.0.
AttributeName PortSpeed 465 466 467 Attribute Description Port Speed IsReadOnly FALSE PossibleValues ”Auto”, “1G”, “2G”, “4G”, “8G”, “16G” Description Link Speed The following table describes the values for the DCIM_FCInteger of this group. Each of the column headings correspond to a property name on the DCIM_FCInteger class. Each of the rows contain the values for the properties listed in the column headings.
26 Version 1.0.
Table 19 – DCIM_FCEnumeration Fiber Channel Target Configuration 487 AttributeName Attribute Description BootScanSelection 1 Boot Scan Selection IsReadOnly PossibleValues “Disabled”,” FirstLUN” “SpecifiedLUN” FALSE Description 1 Boot scan Selection The “FirstLUN” value in the PossibleValues array property shall be present only on the Qlogic TM 488 NOTE: 489 490 491 The following table describes the values for the DCIM_FCInteger of this group.
Version 1.0.
AttributeName FCTape 1 HardZone 1 FramePayloadSize 1 Attribute Description IsReadOnly FC Tape Enable FALSE “Disabled”, “Enabled” PossibleValues Description FC Tape Enable Hard Zone Enable FALSE “Disabled”, “Enabled” Hard Zone Enable Frame Payload Size FALSE “Auto”, “512”, “1024”, “2048”, “2112” Frame Payload Size 1 508 NOTE: 509 510 511 The following table describes the values for the DCIM_FCInteger of this group.
28 Version 1.0.
AttributeName 524 Attribute Description IsReadOnly Min Length Max Length PCIDeviceID PCI Device ID TRUE 4 4 BusDeviceFunction Bus:Device:Function TRUE 8 8 FamilyVersion Firmware Family Version TRUE 5 8 EFIVersion EFI TRUE 5 8 NOTE: 1 Attribute is optional and may not be available on enumerations. 2 TM 525 526 NOTE: The MaxLength property for the ChipMdl is specific to the FC card vendor.
Version 1.0.
550 Table 26 – Class: DCIM_FCService 551 Properties and Methods SystemCreationClassName Requirement Mandatory Description The property value shall be “DCIM_ComputerSystem”. CreationClassName Mandatory The property value shall be “DCIM_FCService”. ElementName Mandatory The property value shall be “FC Service” SystemName Mandatory The property value shall be “DCIM:ComputerSystem”. Name Mandatory The property value shall be “DCIM:FCService” 552 7.
“Fiber Channel”. 30 Version 1.0.
RegisteredVersion Mandatory String This property shall have a value of “1.0.0”. RegisteredOrganization Mandatory String This property shall have a value of 1 (Other). OtherRegisteredOrganization Mandatory Uint16 This property shall match “DCIM” AdvertisedTypes[] Mandatory Uint16 AdvertiseTypeDescriptions[] Mandatory String ProfileRequireLicense[] Mandatory String This property array shall contain [1(Other), 1 (Other)].
Version 1.0.
Table 29 – DCIM_FCService.SetAttribute( ) Method: Return Code Values 587 Value Description 0 Completed with no error 2 Failed Table 30 – DCIM_FCService.SetAttribute( ) Method: Parameters 588 Qualifiers Name Type Description/Values IN, REQ Target String FQDD of the FC IN, REQ AttributeName String Shall contain the AttributeName property value for the attribute to be modified. IN, REQ AttributeValue[] String Shall contain the desired attribute value.
FC010 32 cannot create Configuration job. Version 1.0.
MessageID (OUT parameter) Message MessageArguments[] FC011 Configuration job already created, pending data cannot be deleted FC012 No pending data present to delete FC013 Invalid AttributeName AttributeName FC014 Invalid AttributeValue for AttributeName AttributeName FC015 AttributeValue cannot be changed for read only AttributeName AttributeName FC016 AttributeValue cannot be changed for disabled AttributeName AttributeNa
property values for the attributes to be modified. Version 1.0.
Qualifiers Name Type Description/Values IN, REQ AttributeValue[] String Shall contain the desired attribute values. If the value is valid, the CurrentValue or PendingValue property of the specified attribute will be modified. OUT SetResult[] String Returns: "Set CurrentValue property" when the attributes current value is set. “Set PendingValue property” when the attributes pending value is set.
FC014 34 AttributeName AttributeName Version 1.0.
MessageID (OUT parameter) Message MessageArguments[] FC015 AttributeValue cannot be changed for read only AttributeName AttributeName FC016 AttributeValue cannot be changed for disabled AttributeName AttributeName FC017 Cannot perform the operation due to an unknown error in iDRAC Set operation failed as the attribute is read only. FC018 LC062 An instance of Export or Import System Configuration is already running. 605 8.3 DCIM_FCService.
Version 1.0.
Table 36 – DCIM_FCService.CreateTargetedConfigJob( ) Method: Parameters 629 630 631 632 Qualifiers Name Type Description/Values IN, REQ Target String FQDD of the FC IN RebootJobType Uint16 Shall contain the requested reboot type: 1 - PowerCycle 2 - Graceful Reboot without forced shutdown 3 - Graceful Reboot with forced shutdown. IN ScheduledStartTime String Start time for the job execution in format: yyyymmddhhmmss. The string "TIME_NOW" means immediate.
FC010 36 Lifecycle Controller is not enabled, Version 1.0.
MessageID (OUT parameter) Message MessageArguments[] cannot create Configuration job.
Version 1.0.
646 Table 40 – DCIM_FCService.
648 See Lifecycle Controller (LC) Integration Best Practices Guide. 38 Version 1.0.
649 10 CIM Elements 650 No additional details specified. 651 11 Privilege and License Requirement 652 653 654 The following table describes the privilege and license requirements for the listed operations. For the detailed explanation of the privileges and licenses, refer to the Dell WSMAN Licenses and Privileges specification.
Version 1.0.
ANNEX A (informative) 657 658 659 660 Change Log 661 Version Date 1.0.0 662 663 Description Initial version. 1.0.0 8/30/2012 Adding DCIM_FCCapabilities and DCIM_FCStatistics. 1.0.0 9/26/2012 1.0.
40 Version 1.0.
