White Papers

ManualsBrandsDell ManualsConverged InfrastructureSystems Management Solution Resources

A Dell EMC Technical White Paper

Standards-based NIC and FC-HBA

management for Dell EMC PowerEdge

servers by using the iDRAC RESTful API and

DMTF Redfish

June 2018

Authors

Texas Roemer, Test Principal Engineer (Dell EMC Enterprise System Test)

Paul Rubin, Sr. Product Manager (Dell EMC Server Solutions Marketing)

Summary of content (20 pages)

PAGE 1
Standards-based NIC and FC-HBA management for Dell EMC PowerEdge servers by using the iDRAC RESTful API and DMTF Redfish June 2018 Authors Texas Roemer, Test Principal Engineer (Dell EMC Enterprise System Test) Paul Rubin, Sr.
PAGE 2
Revisions Date Description June 2018 Initial release The information in this publication is provided “as is.” Dell Inc. makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any software described in this publication requires an applicable software license. Copyright © 2018 Dell Inc. or its subsidiaries.
PAGE 3
Contents 3 1 Introduction ...................................................................................................................................................................5 2 Introduction to iDRAC RESTful API and DMTF Redfish ..............................................................................................6 3 Key benefits of DMTF Redfish .....................................................................................................................................
PAGE 4
Executive summary The growing scale of cloud- and web-based data center infrastructure is reshaping the requirements of IT administrators world-wide. New approaches to Systems Management are required to keep up with the growing and changing market.
PAGE 5
1 Introduction Since the inception of the x86 servers in the late 1980s, IT administrators have sought the means to efficiently manage a growing number of distributed resources. Industry suppliers have responded by developing management interface standards to support common methods of monitoring and controlling heterogeneous systems.
PAGE 6
2 Introduction to iDRAC RESTful API and DMTF Redfish There are various Out-of-Band (OOB) systems management standards available in the industry today. However, there is no single standard that can be easily used within emerging programming standards, can be readily implemented within embedded systems, and can meet the demands of today’s evolving IT solution models.
PAGE 7
3 7 Key benefits of DMTF Redfish Standards-based NIC and FC-HBA management for Dell EMC PowerEdge servers
PAGE 8
3.1 Redfish 2016 NIC and FC-HBA management APIs With the advent of the Redfish 2016 standards, APIs were established for server NIC and FC-HBA management.
PAGE 9
 Using each network device URI, run a GET command to return information for that device such as firmware version and model name along with individual URIs for “Network Device Functions” and “Network Ports”. Example output: @odata.context @odata.id @odata.
PAGE 10
NetworkPorts 0 @odata.id 1 @odata.id 2 @odata.id 3 @odata.id NetworkPorts@odata .count Description Id Manufacturer Model Name NetworkDeviceFunct ions @odata.id NetworkPorts @odata.id PartNumber SerialNumber Status Health HealthRollup State  "/redfish/v1/Systems/System.Embedded.1/NetworkAdapters/NIC.Int egrated.1/NetworkPorts/NIC.Integrated.1-4" "/redfish/v1/Systems/System.Embedded.1/NetworkAdapters/NIC.Int egrated.1/NetworkPorts/NIC.Integrated.1-2" "/redfish/v1/Systems/System.Embedded.
PAGE 11
0 1 2 @odata.context @odata.id @odata.type AssignablePhysicalPor ts 0 @odata.id AssignablePhysicalPor ts@ odata.count Description Ethernet MACAddress MTUSize PermanentMACAddress FibreChannel BootTargets 0 LUNID WWPN FCoEActiveVLANId FCoELocalVLANId PermanentWWNN PermanentWWPN WWNN WWNSource WWPN Id MaxVirtualFunctions Name NetDevFuncCapabilitie s 0 1 NetDevFuncType PhysicalPortAssignmen t @odata.
PAGE 12
CHAPUsername IPAddressType IPMaskDNSViaDHCP InitiatorDefaultGatew ay InitiatorIPAddress InitiatorName InitiatorNetmask PrimaryDNS PrimaryLUN PrimaryTargetIPAddres s PrimaryTargetName PrimaryTargetTCPPort PrimaryVLANEnable PrimaryVLANId SecondaryDNS SecondaryLUN SecondaryTargetIPAddr ess SecondaryTargetName SecondaryTargetTCPPor t SecondaryVLANEnable SecondaryVLANId TargetInfoViaDHCP  "" "IPv4" true "0.0.0.0" "0.0.0.0" "iqn.1995-05.com.broadcom.iscsiboot" "0.0.0.0" "0.0.0.0" 0 "0.0.0.
PAGE 13
Id LinkStatus Name NetDevFuncMaxBWAlloc NetDevFuncMinBWAlloc PhysicalPortNumber Status Health HealthRollup State SupportedEthernetCapa bilities 0 SupportedLinkCapabili ties 0 LinkNetworkTechnology LinkSpeedMbps WakeOnLANEnabled 3.3 "NIC.Integrated.
PAGE 14
Note: This PATCH command will create and schedule the configuration job but it WILL NOT reboot the server to apply the change. When ready, use POST a command with ACTION “ComputerSystem.Reset” to reboot the server; this will cause iDRAC with Lifecycle Controller to execute the job and apply the changes. The example below illustrates using the Python script SetNetworkDevicePropertiesRedfish.
PAGE 15
2. Get current property settings for a specific network device port. This example will use “NIC.Integrated.1-1-1”: C:\Python27>SetNetworkDevicePropertiesRedfish.py -ip 192.168.0.120 -u root -p calvin -a NIC.Integrated.1-1-1 - Properties for network device NIC.Integrated.1-1-1 - iSCSIBoot Properties InitiatorDefaultGateway: 0.0.0.0 SecondaryTargetName: CHAPUsername: PrimaryLUN: 0 SecondaryVLANEnable: None SecondaryVLANId: None SecondaryDNS: 0.0.0.0 InitiatorNetmask: 0.0.0.
PAGE 16
Note: Some device properties are read-only while other properties are read-write. To determine the properties that can be modified under different conditions, see documentation of the selected network controller interface. An example is iSCSI boot properties—if iSCSI is being configured by using DHCP then iSCSI boot property settings cannot be modified unless DHCP usage is disabled. 3.
PAGE 17
- PASS, Command passed to power ON server, code return is 204 - WARNING, JobStatus not completed, current status is: "Task successfully scheduled.", percent completion is: "0" <…> - WARNING, JobStatus not completed, current status is: "Job in progress.
PAGE 18
PrimaryVLANId: None AuthenticationMethod: None PrimaryTargetIPAddress: 0.0.0.0 PrimaryVLANEnable: None - FibreChannel Properties WWNN: 20:00:18:66:DA:91:9B:49 PermanentWWNN: 20:00:18:66:DA:91:9B:49 PermanentWWPN: 20:01:18:66:DA:91:9B:49 FCoELocalVLANId: None FCoEActiveVLANId: 1 WWNSource: ProvidedByFabric WWPN: 20:01:18:66:DA:91:9B:49 BootTargets: [{u'WWPN': u'00:00:00:00:00:00:00:00', u'LUNID': u'0'}] 3.
PAGE 19
4 Summary The DMTF Redfish standard is emerging as a key new tool for efficient, scalable, and secure server management. Utilizing an industry-standard interface and data format, Redfish supports rapid development of automation for one-to-many server management. System administrators and IT developers will appreciate Redfish features that can increase efficiency, lower costs and boost productivity across their organizations.
PAGE 20
5 Additional information        20 For more information on iDRAC9 and 14G BIOS, visit the BIOS section of the iDRAC9 white paper library on Dell Techcenter http://delltechcenter.com/idrac DMTF white papers, Redfish Schemas, specifications, webinars and work-in-progress documents https://www.dmtf.org/standards/redfish The Redfish standard specification is available from the DMTF website http://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.0.1.