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-07-08 26 Version: 1.3.
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 3.1 209 210 3.2 211 212 213 3.3 214 215 216 3.4 217 218 3.5 219 220 3.6 221 222 3.7 223 224 225 3.8 226 227 228 3.9 229 230 231 3.10 232 233 234 3.11 235 236 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.
237 238 3.13 239 240 Interop Namespace: root/interop is where instrumentation instantiates classes to advertise its capabilities for client discovery. 241 242 3.14 243 244 Implementation Namespace: root/dcim is where instrumentation instantiates classes relevant to executing core management tasks. 245 3.15 ENUMERATE - Refers to WS-MAN ENUMERATE operation as described in Section 8.2 of 246 247 Interop Namespace: root/interop Implementation Namespace: root/dcim DSP0226_V1.1 and Section 9.
274 5 Synopsis 275 Profile Name: Simple NIC 276 Version: 1.3.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 Figure 1 – Simple NIC Profile: Class Diagram 306 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 NIC.Slot.n Config 2 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 Table 4 – CNA Properties in DCIM_NICView 340 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 368 Virtual address attributes include the following attributes: VirtMacAddr VirtIscsiMacAddr VirtFIPMacAddr VirtWWN VirtWWPN VirtualizationMode 369 370 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. 371 372 To set these attributes, see Section 8.1 and 8.2 for more details.
Difference Broadcom QLogic Port level If NicPartitioning attribute is disabled, then enumeration and a get operations only displays port level attributes. t t r i b u t e s Not applicable as NicPartitioning cannot be disabled. Version 1.3.
Difference MinBandwith Broadcom Ifs the MinBandwidth attribute(s) are set, the total sum of all the MinBandwidth attributes for all partitions on a port must add u up m to 0 or 100 at the conclusion of set operation. For example, if the MinBandwidth needs to be changed to 50 on m partition 1, then the Minbandwidth must be changed on other a partition(s) to make sure the MinBandwidth for all partitions on t 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. 399 7 Implementation Description 400 401 Requirements and guidelines for propagating and formulating certain properties of the classes are discussed in this section. Methods are listed in section 8.
NIC View – DCIM_NICView 406 7.1 407 This section describes the implementation for the DCIM_NICView class. 408 This class shall be instantiated in the Implementation Namespace: root/dcim. 409 7.1.1 410 411 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_NICView?__cimnamespace=root/dcim” 412 The key property shall be the InstanceID. 413 414 415 The instance Resource URI for DCIM_NICView instance shall be: “http://schemas.dell.
Property Name Requirement Type Requirement and description FCoEWWNN Mandatory String Indicates FCoE World Wide Node Name. FamilyVersion Mandatory String Indicates the firmware family version. FunctionNumber Mandatory uint8 The function number for this PCI device. LinkDuplex Mandatory String Indicates whether the Link is full or half duplex. LinkSpeed Mandatory String Indicates the link speed.
Property Name VirtWWPN Requirement Type Mandatory String Requirement and description Programmatically assignable Fibre Channel World Wide Port Name identifier for partition FCoE 425 20 Version 1.3.
NIC Capabilities – DCIM_NICCapabilities 426 7.2 427 This section describes the implementation for the DCIM_NICCapabilities class. 428 This class shall be instantiated in the Implementation Namespace: root/dcim. 429 7.2.1 430 431 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_NICCapabilities?__cimnamespace=root/dcim” 432 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.
Table 12 – DCIM_NICStatistics - Operations 458 Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 459 7.3.3 Properties 460 461 462 463 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.
Resource URIs for WinRM® 470 7.4.1 471 472 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_NICEnumeration?__cimnamespace=root/dcim” 473 The key property shall be the InstanceID. 474 475 476 The instance Resource URI for DCIM_NICEnumeration instance shall be: “http://schemas.dell.
Table 15 – Class: DCIM_NICEnumeration 486 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.
500 7.5.2 Operations 501 The following table lists the implemented operations on DCIM_NICString. Table 16 – DCIM_NICString - Operations 502 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 503 504 7.5.
Table 17 – Class: DCIM_NICString 509 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.
Resource URIs for WinRM® 516 7.6.1 517 518 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_NICInteger?__cimnamespace=root/dcim” 519 The key property shall be the InstanceID. 520 521 522 The instance Resource URI for DCIM_NICInteger instance shall be: http://schemas.dell.
Table 19 – Class: DCIM_NICInteger 533 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.
543 544 545 546 547 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.
567 568 569 570 571 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/Revision TRUE DCBXSupport DCB XSupport TRUE DeviceName This name should be consistent with the name displayed in the operating system.
AttributeName 578 579 580 Attribute Description IsReadO nly 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 Address FALSE Vir
AttributeName BlnkLeds AttributeDisplayName IsReadOnly Blink LEDs for a duration up to 15 seconds. FALSE Display Order LowerBound 1201 UpperBound 0 15 582 7.7.3 NIC Partitioning Configuration 583 This section describes the attributes for NIC’s Partitioning Configuration. 584 585 The GroupID property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “NICPartitioningConfig”.
605 606 607 608 609 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 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 631 7.7.6 Device Level Configuration 632 This section describes the attributes for the NIC’s Device Level Configuration.
650 7.7.7 FCoE Capabilities 651 This section describes the attributes for NIC’s FCoE Capabilities. 652 653 The GroupID property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “FCOECapabilities”. 654 655 The GroupDisplayName property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “FCoE Capabilities”. 656 657 658 659 The following table describes the values for the DCIM_NICString of this group.
671 672 673 674 675 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.
Table 38 – DCIM_NICString Firmware Image Properties 697 AttributeName FamilyVersion Attribute Description Family Version IsReadOnly TRUE Display Order MinLength MaxLength 415 698 7.7.10 Global Bandwidth Allocation 699 This section describes the attributes for NIC’s Partition 1 Configuration. 700 701 The GroupID property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “GlobalBandwidthAllocation”.
722 723 contains constraints on string value formulation. Each of the rows contain the values for the properties listed in the column headings. Table 41 – DCIM_NICString iSCSI First Target Parameters 724 AttributeName 725 726 727 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.
AttributeName 741 742 743 744 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”, “NONE” CHAP Mutual Authentication IpAutoConfig TCP/IP Configuration via Stateful or Stateless AutoConfiguration
AttributeName AttributeDisplayName IsReadOnly Display Order 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 750 7.7.13 iSCSI Initiator Parameters 751 This section describes the attributes for NIC’s iSCSI Initiator Parameters. 752 753 The GroupID property for the DCIM_NICEnumeration, DCIM_NICString, and DCIM_NICInteger shall be “IscsiInitiatorParams”.
AttributeName Attribute Description 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 773 774 775 776 AttributeDisplayName IsReadOnly Display Order 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.
Table 50 – DCIM_NICString iSCSI Second Target Parameters 794 AttributeName 795 796 797 Attribute Description 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 816 817 7.8.3 Properties 818 819 820 821 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.
840 7.9.3 Properties 841 842 843 844 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.
853 854 855 856 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. 857 858 859 Return code values for the SetAttribute( ) method are specified in Table 56 and parameters are specified in Table 57.
MessageID (OUT parameter) Message MessageArguments[] 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, pending data cannot be deleted NIC01
Table 60 – DCIM_NICService.SetAttributes( ) Method: Parameters 876 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.
878 8.3 DCIM_NICService.CreateTargetedConfigJob( ) 879 880 881 The CreateTargetedConfigJob( ) method is used to apply the pending values created by the SetAttribute and SetAttributes methods. The successful execution of this method creates a job for application of pending attribute values. 882 CreateTargetedConfigJob method supports the following optional input parameters 883 884 885 1.
Qualifiers 903 904 905 Name 1 Type Description/Values CIM_ConcreteJob REF Reference to the newly created pending value 1 application job.
Table 65 – DCIM_NICService.DeletePendingConfiguration( ) Method: Return Code Values 917 Value Description 0 Success 2 Failed Table 66 – DCIM_NICService.DeletePendingConfiguration( ) Method: Parameters 918 Qualifiers Name Type Description/Values IN, REQ Target String FQDD of the NIC OUT MessageID String Error MessageID OUT Message String Error Message OUT MessageArguments[] String Error MessageArguments Table 67 – DCIM_NICService.
Class and Method Operation User Privilege Required License Required DCIM_NICEnumeration ENUMERATE, GET Login LM_REMOTE_CONFIGURATION DCIM_NICInteger ENUMERATE, GET Login LM_REMOTE_CONFIGURATION DCIM_NICString ENUMERATE, GET Login LM_REMOTE_CONFIGURATION DCIM_NICView ENUMERATE, GET Login LM_REMOTE_ASSET_INVENTORY DCIM_NICStatistics ENUMERATE, GET Login LM_DEVICE_MONITORING DCIM_NICCapabilities ENUMERATE, GET Login LM_REMOTE_ASSET_INVENTORY DCIM_NICService ENUMERATE, GET Login N
ANNEX A (informative) 930 931 932 933 Change Log 934 Version Date Description 1.3.0 2012 Added LC062 error message to the SetAttribute(), SetAttributes(), CreateTargetedConfigJob(), and DeletePendingConfiguration() methods. 1.3.1 3/18/2013 Added VirWWN VirtWWPN properties in the Nic View which were missing 935 936 937 Version 1.3.