Simple NIC 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: DCIM1032 Document Type: Specification Document Status: Published Document Language: E Date: 2013-04-16 26 Version: 1.2.
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. 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.
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 CONTENTS 1 2 3 4 5 6 Scope .................................................................................................................................................... 7 Normative References........................................................................................................................... 7 Terms and Definitions .............................................................
101 Figures 102 103 Figure 1 – Simple NIC Profile: Class Diagram ............................................................................................ 11 104 Tables 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 141 142 143 144 145 146 Table 1 – Related Profiles ...........................................................................................................................
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 Table 48 – DCIM_NICString iSCSI Secondary Device Parameters ........................................................... 46 Table 49 – DCIM_NICEnumeration iSCSI Second Target Parameters ..................................................... 46 Table 50 – DCIM_NICString iSCSI Second Target Parameters................................................................. 47 Table 51 – DCIM_NICInteger iSCSI Second Target Parameters ..
Simple NIC Profile 169 170 1 171 172 173 174 The Simple NIC Profile extends the management capabilities of referencing profiles by adding the capability to represent the configuration of NIC network controllers. The NIC controllers are modeled as views and attributes where there is a view for each individual controller and multiple attributes that allow NIC configuration. 175 2 176 Refer to the following documents for more information.
205 3 Terms and Definitions 206 For the purposes of this document, the following terms and definitions apply. 207 208 can - Used for statements of possibility and capability, whether material, physical, or causal. 209 210 cannot - Used for statements of possibility and capability, whether material, physical, or causal. 211 212 213 conditional - Indicates requirements to be followed strictly in order to conform to the document when the specified conditions are met. 3.1 3.2 3.3 3.
3.13 237 238 Interop Namespace: root/interop 239 240 Interop Namespace: root/interop is where instrumentation instantiates classes to advertise its capabilities for client discovery. 241 242 3.14 Implementation Namespace: root/dcim 243 244 Implementation Namespace: root/dcim is where instrumentation instantiates classes relevant to executing core management tasks. 245 246 247 3.15 ENUMERATE - Refers to WS-MAN ENUMERATE operation as described in Section 8.2 of DSP0226_V1.1 and Section 9.
274 5 Synopsis 275 Profile Name: Simple NIC 276 Version: 1.2.0 277 Organization: Dell Inc. 278 CIM Schema Version: 2.26 Experimental 279 Central Class: DCIM_NICService 280 Scoping Class: CIM_ComputerSystem 281 282 283 284 The Simple NIC Profile extends the management capability of the referencing profiles by adding the capability to describe NIC controllers in a simple way.
DCIM_LCRegisteredProfile RegisteredProfile = “Simple NIC” OtherRegisteredOrganization = “DCIM” Interop Namespace Implementation Namespace DCIM_LCElementConformsToProfile DCIM_NICService DCIM_NICView DCIM_NICCapabilities DCIM_NICStatistics CIM_BIOSAttribute DCIM_NICAttribute DCIM_NICEnumeration DCIM_NICInteger DCIM_NICString 305 306 Figure 1 – Simple NIC Profile: Class Diagram 307 6.
320 Table 2 - NIC FQDD examples FQDD Friendly Name NIC.Integrated.1-2-3 Integrated NIC 1 Port 2 Partition 3 NIC.Slot.3-2-1 NIC in Slot 3 Port 2 Partition 1 NIC.Mezzanine.1B-1-2 NIC in Mezzanine 1 Port 1 Partition 2 321 322 Table 3 - CNA FQDD Example Physical Port Function Instance off Physical Port PCI Func # Config 1 Config 2 NIC.Slot.n NIC.Slot.n 1 1 0 NIC.Slot.1-1-1 NIC.Slot.1-1-1 2 2 NIC.Slot.1-1-2 NIC.Slot.1-1-2 3 4 NIC.Slot.1-1-3 NIC.Slot.1-1-3 4 6 NIC.Slot.1-1-4 NIC.
339 340 Table 4 – CNA Properties in DCIM_NICView Personality Detail NicMode Indicates if the NIC personality is enabled or disabled on the current partition FCoEOffloadMode Indicates if the Fibre Channel over Ethernet (FCoE) personality is enabled or disabled on the current partition. iScsiOffloadMode Indicates if the Internet Small Computer System Interface (iSCSI) personality is enabled or disabled on current partition MaxBandwidth Indicates maximum bandwidth on current partition.
361 6.6 Virtual Address attributes 362 363 364 365 366 367 Virtual address attributes include the following attributes: • VirtMacAddr • VirtIscsiMacAddr • VirtFIPMacAddr • VirtWWN • VirtWWPN 368 369 The default values of these virtual attributes is equal to the permanent addresses programmed onto the controller. For example, the VirtMacAddr default value is MacAddr on that port or partition.
Difference Broadcom QLogic Port level If NicPartitioning attribute is disabled, then enumeration and get operations only displays port level attributes. Not applicable as NicPartitioning cannot be disabled. Version 1.2.
Difference MinBandwith Broadcom QLogic If the MinBandwidth attribute(s) are set, the total sum of all the MinBandwidth attributes for all partitions on a port must add up to 0 or 100 at the conclusion of set operation. For example, if the MinBandwidth needs to be changed to 50 on partition 1, then the Minbandwidth must be changed on other partition(s) to make sure the MinBandwidth for all partitions on the port adds to a 100.
Difference Broadcom QLogic NicMode NicMode is used to enable or disable NIC personality on a partition. NIC personality can be disabled on all partitions. NIC personality cannot be disabled on partition 1, but can be disabled on remaining partitions. 401 7 Implementation Description 402 403 Requirements and guidelines for propagating and formulating certain properties of the classes are discussed in this section. Methods are listed in section 8.
407 Table 7 – CIM Elements: Simple NIC Profile Element Name Requirement Description Mandatory The class maybe implemented in the Implementation Namespace: root/dcim. Classes DCIM_NICService See sections 7.8 DCIM_NICView Mandatory The class shall be implemented in the Implementation Namespace: root/dcim. DCIM_NICCapabilities Mandatory The class shall be implemented in the Implementation Namespace: root/dcim.
418 7.1.2 Operations 419 The following table lists the implemented operations on DCIM_NICView. 420 Table 8 – DCIM_NICView - Operations Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 421 7.1.3 Class Properties 422 423 424 425 The following table details the implemented properties for DCIM_NICView instance representing a NIC in a system.
Property Name Requirement Type Requirement and description PCISubDeviceID Mandatory string The property contains a value assigned by the vendor manufacturer used to identify the type of device. PCISubVendorID Mandatory string Indicates the subsystem vendor ID. PCIVendorID Mandatory string The property contains a value assigned by the PCI SIG used to identify the manufacturer of the device. PermanentFCOEMACAddress Mandatory string Indicates the permanent FCoE MAC Address.
429 7.2 NIC Capabilities – DCIM_NICCapabilities 430 This section describes the implementation for the DCIM_NICCapabilities class. 431 This class shall be instantiated in the Implementation Namespace: root/dcim. 432 7.2.1 433 434 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_NICCapabilities?__cimnamespace=root/dcim” 435 The key property shall be the InstanceID.
Property Name Requirement Type FCoEMaxIOsPerSession Mandatory uint16 The property shall represent maximum number of IOs per connection supported for the NIC. FCoEMaxNPIVPerPort Mandatory uint16 The property shall represent maximum number of FCoE targets supported for the NIC. FCoEMaxNumberExchanges Mandatory uint16 The property shall represent maximum number of exchanges for the NIC. FCoEMaxNumberLogins Mandatory uint16 The property shall represent maximum logins per port for the NIC.
Property Name Requirement Type Requirement and description RXFlowControl Mandatory uint8 The property shall represent RX flow control support for a NIC port. RemotePHY Mandatory uint8 The property shall represent remote PHY support for a NIC port. TCPChimneySupport Mandatory uint8 The property shall represent TCP Chimney support for a NIC port. TXBandwidthControlMaximum Mandatory uint8 The property shall represent open flow support for a NIC partition.
461 Table 12 – DCIM_NICStatistics - Operations Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 462 7.3.3 Properties 463 464 465 466 The following table details the implemented properties for DCIM_NICStatistics instance representing a NIC in a system. The “Requirements” column shall denote whether the property is implemented (for requirement definitions, see section 3).
Property Name Requirement Type Requirement and description RxPauseXONFrames Mandatory uint32 Counts the flow control frames from the network to resume transmission. RxRuntPkt Mandatory uint32 Counts the total number of frames that are too short (< 64 bytes). RxUnicast Mandatory uint64 Counts the total number of good unicast packets transmitted. StartStatisticTime Mandatory datetime Indicates the measurment time for the first NIC statistics.
477 478 479 The instance Resource URI for DCIM_NICEnumeration instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_NICEnumeration?__cimnamespace=root/dcim+InstanceID= :” 480 where is the FQDD property value and is the AttributeName property value. 481 7.4.2 482 The following table lists the implemented operations on DCIM_NICEnumeration.
489 Table 15 – Class: DCIM_NICEnumeration Properties Type Notes Additional Requirements InstanceID String Mandatory 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 from the “AttributeDisplayName” column in Tables in section 7.7.
503 7.5.2 Operations 504 The following table lists the implemented operations on DCIM_NICString. 505 Table 16 – DCIM_NICString - Operations Operation Name Get Enumerate DCIM_NICService.SetAttributte() DCIM_NICService.SetAttributes() Requirements Mandatory Mandatory Mandatory Mandatory Required Input Instance URI Class URI See section 8.1 See section 8.2 506 507 7.5.
512 Table 17 – Class: DCIM_NICString Properties Type Notes Additional Requirements InstanceID String Mandatory 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 from the “AttributeDisplayName” column in in Tables in section 7.7.
518 This class shall be instantiated in the Implementation Namespace:root/dcim. 519 7.6.1 520 521 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_NICInteger?__cimnamespace=root/dcim” 522 The key property shall be the InstanceID. 523 524 525 The instance Resource URI for DCIM_NICInteger instance shall be: http://schemas.dell.
536 Table 19 – Class: DCIM_NICInteger Properties Type Requirement Additional Requirements InstanceID String Mandatory 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 from the “AttributeDisplayName” column in in Tables in section 7.7.
546 547 548 549 550 The following table describes the values for the DCIM_NICEnumeration of this group. Each of the column headings correspond to a property name on the DCIM_NICEnumeration class. The Description column contains the description for each of the attribute. Each of the rows contain the values for the properties listed in the column headings. The PossibleValues property is an array property represented in the table as comma delimited list.
570 571 572 573 574 The following table describes the values for the DCIM_NICEnumeration of this group. Each of the column headings correspond to a property name on the DCIM_NICEnumeration class. The Description column contains the description for each of the attribute. Each of the rows contain the values for the properties listed in the column headings. The PossibleValues property is an array property represented in the table as comma delimited list.
AttributeName Attribute Description IsReadO nly BusDeviceFunction Bus, Device, Function values TRUE ChipMdl Chip Type/Revisio n TRUE DCBXSupport DCB XSupport TRUE DeviceName This name should be consistent with the name displayed in the operating system.
Attribute Description AttributeName IsReadO nly RemotePHY RemotePHY TRUE RXFlowControl RX Flow Control TRUE TOESupport TOE Support TRUE TXBandwidthControlMaximum TX Bandwidth Control Maximum TRUE TXBandwidthControlMaximum TX Bandwidth Control Maximum TRUE TXBandwidthControlMinimum TX Bandwidth Control Minimum TRUE TXBandwidthControlMinimum TX Bandwidth Control Minimum TRUE TXFlowControl TX Flow Control TRUE TXFlowControl TX Flow Control TRUE VirtFIPMacAddr Virtual FIP Mac Addr
AttributeName BlnkLeds AttributeDisplayName IsReadOnly Blink LEDs for a duration up to 15 seconds. FALSE Display Order LowerBound 1201 UpperBound 0 15 587 7.7.3 NIC Partitioning Configuration 588 This section describes the attributes for NIC’s Partitioning Configuration. 589 590 The GroupID property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “NICPartitioningConfig”.
610 611 612 613 614 The following table describes the values for the DCIM_NICEnumeration of this group. Each of the column headings correspond to a property name on the DCIM_NICEnumeration class. The Description column contains the description for each of the attribute. Each of the rows contain the values for the properties listed in the column headings. The PossibleValues property is an array property represented in the table as comma delimited list.
Attribute Description AttributeName IsReadOnly Display Order MinLength MaxLength CongestionNotification Congestion Notification TRUE 201 0 0 DCBExchangeProtocol DCB Exchange Protocol TRUE 202 0 0 EnhancedTransmissionSelection Enhanced Transmission Selection TRUE 203 0 0 PriorityFlowControl Priority Flow Control TRUE 204 0 0 636 7.7.6 Device Level Configuration 637 This section describes the attributes for the NIC’s Device Level Configuration.
655 7.7.7 FCoE Capabilities 656 This section describes the attributes for NIC’s FCoE Capabilities. 657 658 The GroupID property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “FCOECapabilities”. 659 660 The GroupDisplayName property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “FCoE Capabilities”. 661 662 663 664 The following table describes the values for the DCIM_NICString of this group.
676 677 678 679 680 The following table describes the values for the DCIM_NICEnumeration of this group. Each of the column headings correspond to a property name on the DCIM_NICEnumeration class. The Description column contains the description for each of the attribute. Each of the rows contain the values for the properties listed in the column headings. The PossibleValues property is an array property represented in the table as comma delimited list.
702 Table 38 – DCIM_NICString Firmware Image Properties Attribute Description AttributeName FamilyVersion Family Version IsReadOnly TRUE Display Order MinLength MaxLength 415 703 7.7.10 Global Bandwidth Allocation 704 This section describes the attributes for NIC’s Partition 1 Configuration. 705 706 The GroupID property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “GlobalBandwidthAllocation”.
727 728 contains constraints on string value formulation. Each of the rows contain the values for the properties listed in the column headings. 729 Table 41 – DCIM_NICString iSCSI First Target Parameters AttributeName 730 731 732 Attribute Description IsReadOnly Display Order MinLength MaxLength Value Expression FirstTgtChapId iSCSI first target CHAP ID. FALSE 604 0 32 String FirstTgtIpAddress iSCSI first target IP address.
AttributeDisplayName IsReadOnly Display Order PossibleValues BootToTarget Boot to iSCSI target after connection FALSE 701 “Disabled”, “Enabled” Boot to iSCSI target after connection ChapAuthEnable CHAP Authentication FALSE 702 “Disabled”, “Enabled” CHAP Authentication ChapMutualAuth CHAP Mutual Authentication FALSE 703 “Disabled”, “Enabled”, CHAP Mutual Authentication AttributeName Description “NONE” 746 747 748 749 IpAutoConfig TCP/IP Configuration via Stateful or Stateless AutoC
AttributeName Display Order AttributeDisplayName IsReadOnly LinkUpDelayTime Link Up Delay Time FALSE 706 LunBusyRetryCnt Number of retries in 2 sec intervals when LUN is busy (0..60) TRUE 707 LowerBound UpperBound 0 755 7.7.13 iSCSI Initiator Parameters 756 This section describes the attributes for NIC’s iSCSI Initiator Parameters. 757 758 The GroupID property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “IscsiInitiatorParams”.
Attribute Description AttributeName IsReadOnly Display Order MinLength MaxLength Value Expression 0 32 String IscsiInitiatorChapId iSCSI initiator CHAP ID. FALSE 804 IscsiInitiatorChapPwd Initiator CHAP Secret (12 to 16 characters in length).Note: this attribute can either take a value of ‘0’or 12 to 16. FALSE 801 IscsiInitiatorGateway iSCSI initiator default gateway IP address. FALSE 805 2 39 IP Address IscsiInitiatorIpAddr iSCSI initiator IP address.
AttributeName 778 779 780 781 Display Order AttributeDisplayName IsReadOnly PossibleValues Description UseIndTgtName Use independent target name when multipath I/O is enabled. FALSE 902 “Disabled”, “Enabled” Use Independent Target Name when multipath I/O is enabled UseIndTgtPortal Use independent target portal when multipath I/O is enabled.
799 Table 50 – DCIM_NICString iSCSI Second Target Parameters Attribute Description AttributeName 800 801 802 IsReadOnly Display Order MinLength MaxLength Value Expression 0 32 String SecondTgtChapId iSCSI second target CHAP ID. FALSE 1003 SecondTgtChapPwd CHAP Secret FALSE 1001 SecondTgtIpAddress iSCSI second target IP address. FALSE 1004 2 39 IP address SecondTgtIscsiName iSCSI second target name.
Invoke Mandatory Instance URI 821 822 7.8.3 Properties 823 824 825 826 The following table details the implemented properties for DCIM_NICService instance representing a system in a system. 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.
845 7.9.3 Properties 846 847 848 849 The following table details the implemented properties for DCIM_LCRegisteredProfile instance representing Simple NIC 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.
858 859 860 861 DCIM_NICAttribute.IsReadOnly property is FALSE. Invocation of this method when the DCIM_NICAttribute.IsReadOnly property is TRUE shall result in no change to the value of the DCIM_NICAttribute.CurrentValue property. The results of changing this value is described with the SetResult parameter. 862 863 864 Return code values for the SetAttribute( ) method are specified in Table 56 and parameters are specified in Table 57.
MessageID (OUT parameter) Message MessageArguments[] target until existing job is completed or is cancelled NIC007 Configuration job already created, cannot create another config job on specified target until existing job is completed or is cancelled NIC008 No pending data is present to create a Configuration job NIC009 System Services is currently in use, cannot create Configuration job NIC010 System Services is disabled, cannot create Configuration job NIC011 Configuration job already created
881 Table 60 – DCIM_NICService.SetAttributes( ) Method: Parameters Qualifiers Name Type Description/Values IN, REQ Target String FQDD of the NIC IN, REQ AttributeName[] String An array of values where each value shall be formatted in the following way: #. Example: “MyGroup#MyAttribute” IN, REQ AttributeValue[] String Shall contain the desired attribute values.
888 889 890 1. RebootJobType: When provided in the input parameters, creates a specific reboot job to “PowerCycle”, “Graceful Reboot without forced shutdown”, or “Graceful Reboot with forced shutdown”. This parameter only creates the RebootJob and does not schedule it. 891 892 893 2. ScheduledStartTime: When provided in the input parameters, schedules the “configuration job” and the 894 895 896 3.
908 909 910 NOTE: 1 – If return code is 4096 (Job Created), the newly created job will not execute if the LC core services are not running (DCIM_LCEnumeration with AttributeName equal to “LifecycleControllerState” has the CurrentValue property equal to “Disabled”). 911 912 Table 64 – DCIM_NICService.
Qualifiers Name Type Description/Values OUT Message String Error Message OUT MessageArguments[] String Error MessageArguments 924 Table 67 – DCIM_NICService.
Class and Method Operation User Privilege Required License Required DCIM_NICService. CreateTargetedConfigJob() Login, Configure LM_REMOTE_CONFIGURATION INVOKE DCIM_NICService. DeletePendingConfiguration() Login, Configure LM_REMOTE_CONFIGURATION INVOKE DCIM_LCRegisteredProfile ENUMERATE, GET Login None. DCIM_LCElementConformsToProfile ENUMERATE, GET Login None. 934 56 Version 1.2.
ANNEX A (informative) 935 936 937 938 Change Log 939 Version Date Description 1.2.1 03/21/2012 Removed the following properties from the DCIM_NICStatistics class: RxValidBytes, RxErrorPktsRunt, RxErrorsPktsJabber, and RxControlFrames. 1.2.2 08/30/2012 Qlogic supports setting of minimum bandwidth for CNA partitions. 1.2.3 04/16/2013 Updated CNA model list, and also added dependency information for setting virtual address attributes. 940 941 942 Version 1.2.
