Transcription
Intel Server Debug and Provisioning ToolUser GuideA setup, usage and troubleshooting guide for Intel Server SystemsRev 2.1-0April 2021Intel Server Products and Solutions
Intel Server Debug and Provisioning Tool User Guide This page is intentionally left blank 2
Intel Server Debug and Provisioning Tool User GuideDocument RevisionsDateOctober 2020Revision1.4-1Changes Python 3.0 SupportHelp modification Support added for below Oses Red Hat* Enterprise Linux 8.x SuSE* Linux* Enterprise Server 15 Centos 8.x and Ubuntu 20.04 LTSPython3.x support added for below platforms Intel(R) Server Board S2600 series (Intel(R) Xeon(R) processorE5-2600 v3/v4 product family) Intel Server Board (Intel Xeon Scalable Processor Family) Intel Server Board (2nd Generation Intel Xeon ScalableProcessor Family) Intel Server Board (Intel Xeon Platinum 9200 ProcessorFamily)Custom deploy update with -no user interactionUpdate with -no user interactionGet BIOS options with -no user interactionsdptool update script issue.Error Code added for Help message November 20201.4-2 January 20211.4-3 March 20211.4-4 Fixed Static scan issuesOn Intel(R) Server Board S2600 series (Intel(R) Xeon(R)processor E5-2600 v3/v4 product family), Fixed Vmedia mount failing next time after trying to mount theimage using Vmedia with -no user interaction switch (eventhough not supported)Fixed get SEL when "-" was present in the path to save the file.Redfish Integration to fifteen existing commands (inputmechanism will be same as in legacy IPMI as before howeverthe output might slightly change depending upon availability ofredfish on the target machine).Changes in input and output mechanism for four newcommands.Some changes in the install scripts to use native packagemanagers for installation, update and uninstallation.Added a new exit error code for invalid length for FRU fields.3
Intel Server Debug and Provisioning Tool User GuideMarch 20212.0-0 April 20212.1-0 New Platform (M70KLP) support added.Storageinfo and nicinfo added which will provide informationregarding storage and network devices.Added support for online firmware version checker4
Intel Server Debug and Provisioning Tool User GuideDisclaimersIntel technologies’ features and benefits depend on system configuration and may require enabled hardware, software, or serviceactivation. Performance varies depending on system configuration. No computer system can be absolutely secure. Check with yoursystem manufacturer or retailer or learn more at intel.com.You may not use or facilitate the use of this document in connection with any infringement or other legal analysis concerning Intelproducts described herein. You agree to grant Intel a non-exclusive, royalty-free license to any patent claim thereafter drafted whichincludes subject matter disclosed herein.No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document.The products described may contain design defects or errors known as errata which may cause the product to deviate frompublished specifications. Current characterized errata are available on request.Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitnessfor a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, orusage in trade.This document contains information on products, services and/or processes in development. All information provided here is subjectto change without notice. Contact your Intel representative to obtain the latest Intel product specifications.Copies of documents which have an order number and are referenced in this document may be obtained by calling 1-800-548-4725or by visiting www.intel.com/design/literature.htm.Intel, the Intel logo, are trademarks of Intel Corporation or its subsidiaries in the U.S. and/or other countries.*Other names and brands may be claimed as the property of others.Copyright 2021 Intel Corporation. All rights reserved. Intel Corporation, 2200 Mission College Blvd., Santa Clara,CA 95052-8119, USA.5
Intel Server Debug and Provisioning Tool User GuideTable of Contents1. Introduction . 101.1Document Scope . 101.2System Requirements . 101.3Terminology . 111.4Related Documents . 111.5Intel Support . 112. Get Started . 122.12.1.1Prerequisites for Installation . 12Prerequisite Packages . 122.2Installation Steps. 122.3Uninstallation Steps . 132.4Update Steps . 132.5Intel Data Center Manager. 132.5.1SDPTool Configuration File . 142.5.2Adding a Platform for an SUP Update. 142.5.3Adding a Platform for a Custom Update . 152.5.4Sudoers . 152.6User Privileges . 152.7Network ports . 163. Feature Script . 173.1General Rules . 173.2Update Firmware . 173.2.1SUP Folder Based . 173.2.2Config File Based . 183.3Custom Deploy. 183.3.1Custom Folder based . 183.3.2Config File based . 183.4Set Options . 193.5Set Bios Config (redfish version of setoptions) . 193.6Deploy Options . 193.6Set Bios Config All (redfish version of deployoptions) . 193.7Get Bios Options . 203.8Get Bios Config (redfish version of getbiosoptions) : . 203.9Get INI. 203.10Get Bios Config all (redfish version of getini) . 203.11KVM . 213.12Vmedia . 213.12.1IPMI Based :. 213.12.2Redfish Based : . 213.13IPMI . 216
Intel Server Debug and Provisioning Tool User Guide3.14Power . 213.15Sensor . 223.16SEL . 223.17Set LAN . 223.18Disable LAN . 223.19Set LAN IPV6 . 223.20Disable LAN IPV6. 223.21LAN Fail Over . 233.22Node Position . 233.23System Info . 233.24FRU . 233.25Memory Info . 233.26CPU Info . 233.27Memory Temperature . 233.28Power Statistics. 243.29Set LAN DHCP . 243.30Set LAN DHCP IPV6 . 243.31Set LAN Stateless ICMPV6 . 243.32Debug Log . 243.33Supported Updates . 243.34Unmount . 253.34.1IPMI based :. 253.34.2Redfish based: . 253.35Storage Info . 253.36Nic Info. 253.37Online firmware checker . 264. custom deploy. 275. Troubleshooting Tips . 285.1SSH Command Sudo Error . 285.2Tar Time Stamp Messages . 285.3Kvm launch glibc version error (SLES 11.4-64bit) . 295.4Reboot features OOB unable to start on S2600WT/ S2600KP/ S2600TP/S2600CW family(SLES11.4-64bit) . 295.5Multithread issue (RHEL 6.8-64bit). 305.6Soft-reset issue (SLES 11.4-64bit) . 305.7Java version required (Java 1.7) . 305.8Proxy Settings . 306. Error Codes . 317. IPMI Reboot features list . 348. Redfish features list . 367
Intel Server Debug and Provisioning Tool User GuideList of TablesTable 1. Operating systems and Intel Server Boards supported . 10Table 2. Terminology . 11Table 3. Error codes . 31Table 4. IPMI Reboot features list . 34Table 5. Redfish features list . 36Table of FiguresFigure 1: Proxy settings in a browser (ex. Mozilla* Firefox) . 13Figure 2: FRU print details . 15Figure 3: SSH command error. 28Figure 4: Tar timestamp messages . 28Figure 5: KVM launch . 29Figure 6: Reboot features OOB. 29Figure 7: Soft reset issue . 30Figure 8: Java version . 308
Intel Server Debug and Provisioning Tool User Guide9
Intel Server Debug and Provisioning Tool User Guide1.IntroductionThe Intel Server Debug and Provisioning Tool (Intel SDP Tool) is a single-server tool to debug and provisionIntel Server Boards and Systems through the BMC Out-of-band.Intel SDPTool is designed to work with the following Intel Server Board families: 1.1Intel Server Board S2600WT/S2600WTR familyIntel Server Board S2600KP/S2600KPR familyIntel Server Board S2600TP/S2600TPR familyIntel Server Board S2600CW/S2600CWR familyIntel Server Board S2600WF/S2600WFR familyIntel Server Board S2600ST/S2600STR familyIntel Server Board S2600BP/S2600BPR familyIntel Server Board S9200WK familyIntel Server Board D50TNP familyIntel Server Board M50CYP familyIntel Server Board M70KLP familyDocument ScopeThe purpose of this user guide is to help system/server administrators install and use the Intel Server Debugand Provisioning Tool (Intel SDP Tool). This guide provides information on the features and benefits of Intel SDP Tool, as well as software requirements, supported operating systems and platforms. This guide alsoexplains the installation and uninstallation process.Note: Refer to the Intel Server Debug and Provisioning Tool Release Notes for known issues on platformsand during the installation.1.2System RequirementsTable 1. Operating systems and Intel Server Boards supportedIntel Server Boards Intel Server Board S2600WT/S2600WTR familyIntel Server Board S2600KP/S2600KPR familyIntel Server Board S2600TP/S2600TPR familyIntel Server Board S2600CW/S2600CWR familyIntel Server Board S2600WF/S2600WFR familyIntel Server Board S2600ST/S2600STR familyIntel Server Board S2600BP/S2600BPR familyIntel Server Board S9200WK familyIntel Server Board D50TNP familyIntel Server Board M50CYP familyIntel Server Board M70KLP familyOperating System Version Red Hat* Enterprise Linux 8.1, 8.2, 7.3, 7.5 and7.6-64 Bit. SuSE* Linux* Enterprise Server 15, 12 ServicePack 3-64 Bit CentOS 8.2, 7.5 and 7.3. Ubuntu 16.04 LTS, Ubuntu 18.04 LTS andUbuntu 20.04 LTS10
Intel Server Debug and Provisioning Tool User Guide1.3TerminologyTable 2. TerminologyTermDefinitionBMCBaseboard Management ControllerCLICommand-Line InterfaceFRUField Replaceable UnitIPMIIntelligent Platform Management Interface. Operates independently of theoperating system (OS) and allows you to manage a system remotely, even inthe absence of the OS.RedfishOperates over HTTPs using a REST API independently of the Operating Systemand allows you to manage a system remotely using basic https commands likepost, get, patch, etc.LANLocal Area NetworkManagementIntel Server System where SDPTool is installed. It will be acting as host serverServerwhich has network connectivity to the rest of the managed servers.Managed ServerIntel Server System in a cluster or data center that will be managed byManagement Server.OUT-OF-BANDOut-of-band managed server refers to any system which is configured withvalid IPMI LAN channel and logon account to allow remote management viaIPMI protocol.1.4SDRSensor Data RecordSELSystem Event LogRelated DocumentsIPMI-Intelligent Platform Management Interface Specification, 2nd Generation, v2.0 (available ml)1.5Intel SupportVisit ml for current technical support information andupdates.11
Intel Server Debug and Provisioning Tool User Guide2.Get Started2.1Prerequisites for InstallationThe following tools must be installed prior to the installation of the Intel SDP Tool to ensure properfunctionality. The Intel SDP Tool is a RPM based package and will fail to install if the following prerequisitesare not met. These prerequisites are included with the standard distribution CD/DVD or .iso.2.1.1Prerequisite PackagesThe following application packages are required for installing the Intel SDP Tool: 2.2Python* 3.x and Python 2Ipmitool* 1.8.18Curl* 7.29.0Openssl* 1.0.0x aboveWget* 1.16 abovePython-requestsJava* OpenJDK/Oracle* version 1.7 and above, 64bitIcedtea*-webOpenIPMI* driversdefusedxml python module – currently not supported on Python 2.6.9 by PIPInstallation StepsTo install the Intel SDP Tool on the Management Server1. Download or Copy the Intel SDPTool Package ‘SDPTool-x.y-z.tar.gz’ to the target directory.2. Untar the tar.gz file.Prompt # tar -xvzmf SDPTool-x.y-z.tar.gz3. Go to untarred ‘SDPTool-x.y-z’ directory folder. Run sdptool install.sh to install the package, examplebelow :Prompt # cd path/to/SDPTool-x.y-z Prompt # ./sdptool install.shIf an older version is present, uninstall it first by using the command below:Prompt # ./sdptool uninstall.shOr use the update script:Prompt # ./sdptool update.sh4. Configure the proper proxy settings using a web browser, using the below example from Mozilla* Firefox.Note: Start the Firefox browser setting advance network settings select auto-detect proxy settings forthis network (SDP Tool’s install script will install pip and then install python defusedxml module). Proxy maybe required for getting the packages from pip. Proxy setting may also be needed to set as environmentvariable, contact your system/network administrator for more details. Please check Section 5.8 for FAQ’s.12
Intel Server Debug and Provisioning Tool User GuideFigure 1: Proxy settings in a browser (ex. Mozilla* Firefox)2.3Uninstallation StepsTo uninstall the package, enter the following commands:Prompt # tar -xvzmf SDPTool-x.y-z.tar.gzPrompt # cd path/to/sdptool-x.y-z Prompt # ./sdptool uninstall.sh2.4Update StepsTo update the package, enter the following commandsPrompt # tar -xvzmf SDPTool-x.y-z.tar.gzPrompt # cd path/to/sdptool-x.y-z Prompt # ./sdptool update.sh2.5Intel Data Center ManagerIntel Data Center Manager is a management data center solution stack providing accurate real-timemonitoring (thermal and power), management and platform update (BIOS, BMC, etc.) capabilities on Intel Server Boards & Systems. For more information and a feature list of the Intel Data Center Manager, refer tothe Intel DCM user guide that comes with the download of the tool.To support Intel Data Center Manager, SDPTool provides the following capabilities from an XML basedconfiguration file.13
Intel Server Debug and Provisioning Tool User Guide2.5.1SDPTool Configuration FileThe SDPTool configuration file is an XML file containing the following tags with no pre-defined (default)location for the file, passed as a command argument: ConfigurationSUP FoldersCustom FoldersFRU FieldThe following sample configuration file passed to the Intel SDPTool provides the locations of various SUPand Custom folders that a user can provide instead of providing them in the command line. Configuration SUP Folders S2600BPB /path/to/SUP folder /S2600BPB /SUP Folders Custom Folders FRUField Board Product /FRUField S2600BPB /path/to/Custom folder /S2600BPB /Custom Folders /Configuration Note: SUP is a platform update package provided by Intel . The SUP is usually distributed as a .zip file,unzipping the .zip will yield the SUP Folder. The SUP package contains the required scripts andimages/binaries that will be run in the efi shell to perform the necessary updates of the platform.Note: The Custom Folder is a user defined folder. Users are able to write their own script that will run in theefi shell. Refer to Section 4 for more details2.5.2Adding a Platform for an SUP UpdateTo add different platforms for an SUP based update, add the following line: Configuration SUP Folders S2600BPB /path/to/SUP folder /S2600BPB S2600WFP /path/to/SUP folder of wolfpass /S2600WFP /SUP Folders Custom Folders FRUField Board Product /FRUField S2600BPB /path/to/Custom folder /S2600BPB /Custom Folders /Configuration Note: S2600WFP is the “Board Product” value in the FRU field of the platform.14
Intel Server Debug and Provisioning Tool User Guide2.5.3Adding a Platform for a Custom UpdateTo add a different platform for the custom update feature, add the following line: Configuration SUP Folders S2600BPB /path/to/SUP folder /S2600BPB /SUP Folders Custom Folders FRUField Board Product /FRUField S2600BPB /path/to/Custom folder /S2600BPB S2600WFP /path/to/SUP folder of wolfpass /S2600WFP /Custom Folders /Configuration Note: S2600WFP is the “Board Product” value in the FRU field of the platform.1. The tags are case sensitive.2. The value for the FRU Field can be obtained from one of the left columns of the fru print output.Corresponding values in the right column will form the next tag. In the above example, the FRU Field is a“Board Product”, with the value being “S2600BPB”. The fru fields can be obtained by using the commandin Section 3.21, with the following sample output:Figure 2: FRU print details2.5.4SudoersAdd the DCM user to the sudoers l
Management Server Intel Server System where SDPTool is installed. It will be acting as host server which has network connectivity to the rest of the managed servers. Managed Server Intel Server System in a cluster or data center that will be managed by Management Server.
