System Configuration Utility (DOS) Release Notes Copyright (c) 2003-2007 Intel Corporation All Rights Reserved Feb 27, 2007 The Save and Restore System Configuration utility (syscfg) is a DOS-based program used for saving and restoring Firmware and BIOS settings to a binary file, and for configuring Firmware and BIOS settings via a command line interface. RELEASE NOTES FOR THE SYSCFG UTILITY VERSION 2.0.10 A. CHANGES SINCE PREVIOUS VERSION 1. Banner roll to 2.0.10 2. New command line switches added to support more firmware Settings. 3. Fixed issues found in 2.0.9 RC1 release 4. Single binary for S5000,SC5400 and S3000 platform series. B. DEPENDENCIES 1. Supported on S5000,SC5400 and S3000 platform series. 2. BIOS Version: R70 and above for S5000,Sc5400. R33 and above for S3000. 3. BMC version: BMC 56 or above for S5000 and SC5400 platform series. 4. IPMI 2.0 compliant ESB2 BMC for S5000 and Sc5400 platform series. 5. Opearting Systems supported. 5a. ROM-DOS 6.22 a. The value of FILES field in the config.sys should not be less than 20. b. The AUTOEXEC.BAT should have an entry as "set CAUSEWAY=NOVM" C. HOW TO USE THIS UTILITY 1. Boot to the DOS prompt. 2. Copy the following files to HD in the same hierarchy as below: a. syscfg.exe b. fwadvcfg.dll c. lancfg.dll d. pefcfg.dll e. powercfg.dll f. sercfg.dll g. solcfg.dll h. usercfg.dll i. bootdev.dll j. biosconfig.dll k. \enus\biosconfig\str\strbiosconfig.str l. \enus\fwadvcfg\str\fwadvcfg.str m. \enus\lancfg\str\lancfg.str n. \enus\pefcfg\str\pefcfg.str o. \enus\powercfg\str\powercfg.str p. \enus\sercfg\str\sercfg.str q. \enus\solcfg\str\solcfg.str r. \enus\usercfg\str\usercfg.str s. \enus\bootdev\str\bootdev.str t. \enus\syscfg\str\syscfg.str u. \enus\syscfg\help\HelpMBmc.str v. \enus\syscfg\help\HelpBMC.str 3. Command line Interface 3.1 General 3.1.1 Overall Help /help or /h or /? Example: syscfg /h 3.1.2 Specific Help /help [component] The supported components are lan, user, serial, pef, sol, power, channel, advancedfwcfg, bios and biossettings. If no component is specified, all help is displayed. Example: syscfg /? lan 3.1.3 Information Switch /i [FileName](optional) Example: syscfg /i syscfg.scf 3.2 Save configuration to a binary file. /save or /s Format: syscfg /s [Filename](optional) [/f][/b] Example: syscfg /s syscfg /s "filename" syscfg /s "filename" /b 3.3 Restore configuration from a binary file. /restore or /r Format: syscfg /r "/f" and/or "/b" Example: syscfg /r [Filename](optional) /f syscfg /r [Filename](optional) /f /b 3.4 Display Interface commands a. Displaying Channel Configuration /d channel Format: syscfg /d channel "channel ID" Example: syscfg /d channel 1 b. Displaying LAN Configuration /d LAN Format: syscfg /d LAN "channel ID" "LAN Alert Destination Index" Example: syscfg /d LAN 1 2 c. Displaying Serial/Modem Configuration /d serial Format: syscfg /d serial "channel ID" "Dial String Index" "Page Destination Selector" "Dial String Selector" Example: syscfg /d serial 1 2 3 4 d. Displaying PEF Configuration /d pef Format: syscfg /d pef "filter table index" "policy table index" Example: syscfg /d pef 1 2 e. Displaying SOL Configuration /d sol Format: syscfg /d sol "channel ID" Example: syscfg /d sol 1 f. Displaying User Configuration /d user Format: syscfg /d user "User ID" "Channel ID" Example: syscfg /d user 1 1 g. Displaying Power Configuration /d power Format: syscfg /d power Example: syscfg /d power h. Displaying Advanced Firmware Settings /d fwadvcfg Format: syscfg /d fwadvcfg "Channel ID" "User ID" "SMTP Configuration Index" Example: syscfg /d fwadvcfg 1 2 3 i. Displaying BIOS settings /d bios Format: syscfg /d bios Example: syscfg /d bios j. Displaying BIOS settings (Advanced option) /d biossettings Format: syscfg /d biossettings Example: syscfg /d biossettings "Quiet Boot" k. Display BIOS individual settings (Advanced option) /d biossettings individual Format: syscfg /d biossettings individual "biossetting name1" "biossetting name2" Example: syscfg /d biossettings individual "Quiet Boot" "Post error Pause" 3.5 FW Configuration Commands 3.5.1 USER a. User Configuration /user or /u Format: syscfg /user "user ID" "user name" "user password" Example: syscfg /user 3 "BobT" "gofps" b. Enable User /userenable or /ue Format: syscfg /ue "user ID" "enable/disable user" "channel number" Example: syscfg /ue 1 disable 1 c. User Privilege /userprivilege or /up Format: syscfg /up "user ID" "channel ID" "privilege level limit" "payload enables"[Optional] Example: syscfg /up 1 1 ADMIN 3.5.2 POWER a. Power Restore Policy /powerrestorepolicy or /prp Format: syscfg /prp "power restore policy" Example: syscfg /prp OFF 3.5.3 Platform Event Filtering a. PEF Global Status /pefconfig or /pefc Format: syscfg /pefc "global PEF state" "global control" Example: syscfg /pefc enable alert+pdown+reset+pcycle b. Alert filter /peffilter or /peff Format: syscfg /peff "filter table index" "filter state" "action" "policy number" Example: syscfg /peff 3 enable pdown 1 c. Alert policy This command is not supported in PC87431M-based systems. /pefpolicy or /pefp Format: syscfg /pefp "alert policy table index" "enable" "policy number" "policy behavior" "channel number" "destination table index" Example: syscfg /pefp 1 enable 3 ALWAYS 1 1 3.5.4 Serial Configuration a. Serial/Modem enable settings /serialEnable or /se Format: syscfg /se "channel ID" "Privilege Level Limit" "Connection Mode" "Baud Rate" Example: syscfg /se 4 admin direct 19200 b. Terminal mode settings /termEnable or /te Format: syscfg /te "Channel Id" "Enable/Disable Line Edit" "Delete Control" "Enable/Disable Echo" "Enable/Disable Handshake" "Output Newline Sequence" "Input Newline Sequence" Example: syscfg /te 4 enable DEL enable enable lfcr cr c. Serial Page Enable /serialPageEnable or /spe Format: syscfg /spe "Channel ID" "Page Blackout Interval" "Community String" Example: syscfg /spe 4 3 “modem public” d. Serial Dial String /serialDialString or /sds Format: syscfg /sds "channel ID" "Dial String Index" "Dial String" Example: syscfg /sds 4 1 95154884627 e. Serial Page Configuration /serialPageConf or /spc Format: syscfg /spc "Channel ID" "Destination Selector" "Dial String Selector" "Stop Bits" "Data Bits" "Parity" "Baud Rate" Example: syscfg /spc 4 2 4 2 8 none 19200 f. Serial Configuration /serialConf or /sc Example: syscfg /sc "Channel ID" "Parameter Selector" "Value" The 'Parameter Selector' maps to the parameter selector of the IPMI specs. Parameter selector Value 2a Authentication types for callback 2b Authentication types for user 2c Authentication types for operator 2d Authentication types for admin 3a Enable/Disable Terminal mode 3b Connection Mode 4 Inactivity Timeout 6a Enable/Disable close on DCD loss 6b Enable/Disable Inactivity timeout 7a Baud Rate 7b Enable/Disable DTR Hang-up 7c Flow Control 8a Enable/Disable Mux switch on DCD loss 8b Enable/Disable Mux Baseboard to BMC switch 8c Enable/Disable Mux BMC to Baseboard switch 8i Enable/Disable Ping before Mux switch 8j Enable/Disable Ping 8k Enable/Disable Ping during callback 8l Enable/Disable Connection mode sharing 14 Page Blackout Interval in minutes 15 Community String 29d Enable/Disable Terminal Line Edit 29c Terminal Delete Control 29b Enable/Disable Terminal Echo 29a Enable/Disable Terminal Handshake 29g Terminal Output Newline Sequence 29f Terminal Input Newline Sequence Example: syscfg /serialconf 4 2d none+straight+MD5 Example: syscfg /serialconf 4 2d "" 3.5.5 LAN Configuration a. LAN Enable Configuration /lanenable or /le syscfg /le "LAN Channel ID" "IP Address Source" "Host IP Address" "Subnet Mask IP Address" Example: syscfg /le 1 static 10.78.211.43 255.255.255.0 b. LAN Alert Enable Configuration /lanalertenable or /lae syscfg /lae "LAN Channel ID" "Gateway IP Address" "Gateway MAC Address" "Community String" "Backup Gateway IP Address" "Backup Gateway MAC" Example: syscfg /lae 1 101.78.78.251 00-30-FC-8F-90-BB “” 101.78.79.251 0F-34-32-AA-A8-9B syscfg /lae 1 101.78.78.251 resolve “” 101.78.79.251 resolve c. LAN Alert Configuration /lanalertconf or /lac syscfg /lac "LAN Channel ID" "Alert Destination Index" "Alert Destination IP Address" "Alert MAC Address" "Backup Gateway Enable" "Alert Acknowledge Enable" "Alert Retry Count" "Alert Retry Interval" "Alert Destination Type[SNMP or SMTP]" Example: syscfg /lac 7 1 10.78.211.40 03-FE-EF-02-41-F3 disable disable 0 0 SMTP d. LAN Configuration Parameters /lanconf or /lc syscfg /lc "LAN Channel ID" "Parameter Selector" "Value" The 'Parameter Selector' maps to the parameter selector of the IPMI specs. Parameter Value 2a Authentication types for callback 2b Authentication types for user 2c Authentication types for operator 2d Authentication types for admin 3 Host IP Address 4 IP Address Source 6 Subnet Mask IP Address 10 Enable/Disable Gratuitous ARP Enable 10b Enable/Disable BMC ARP response 11 Gratuitous ARP Interval in milliseconds 12 Gateway IP Address 13 Gateway MAC Address 14 Backup Gateway IP Address 15 Backup Gateway MAC Address 16 Community String Example: syscfg /lc 7 2 none+straight+md5 Example: syscfg /lc 7 2 "" 3.5.6 Channel Configuration /channel or /c syscfg /c gives the channel display of the available session based channels on the system. Example: Channel ID Type Access Mode Privilege Limit Supported Features 1 LAN Disabled Admin HTTP/S, Telnet syscfg /c "Channel ID" "Parameter Selector" "Value" Example: syscfg /c 7 6 enable Example: syscfg /c 1 1 "" Parameter Value 1 Authentication types for callback 2 Authentication types for user 3 Authentication types for operator 4 Authentication types for admin 5 Enable Per Message Authentication 6 Enable User Level Authentication 7 Access Mode for the channels 8 Privilege Level Limit 3.5.7 Serial Over LAN Configuration /solEnable or /sole syscfg /sole "Channel Number" "Enable/Disable SOL" "Privilege Level Limit" "Baud Rate" "Retry Count" "Retry Interval" Example: syscfg /sole 1 enable admin 19200 0 10 3.6 EFI SysCfg compatible switches 3.6.1 LAN Configuration Setting Options (/lde, /lhi, /lsm, /lgi, /lgm) a. Configuring DHCP Enable status: DHCP enable or disable. This option can not be used in conjunction with the options for setting the IP, Subnet Mask, Gateway IP and MAC addresses. Note that “enable DHCP” means that the BMC gets an IP address from the DHCP server. /lde syscfg /lde [value] Example: syscfg /lde 1 b. Configuring the BMC IP address: /lhi syscfg /lde [IP Address] Examples: 1. Configure the BMC IP address to "192.168.0.2" syscfg /lhi 192.168.0.2 2. Restore from a binary file, then configure the BMC IP address to "192.168.0.2" syscfg /r mycfgfile.scf /lhi 192.168.0.2 c. Configuring the Subnet Mask IP address: /lsm syscfg /lsm [IP Address] Example: syscfg /lsm 255.255.255.0 d. Configuring the Default Gateway IP address: /lgi syscfg /lgi [IP Address] Example: syscfg /lgi 192.168.6.26 e. Configuring the Default Gateway MAC address: /lgm syscfg /lgm [MAC Address] Example: syscfg /lgm 0A-56-CF-06-11-02 3.6.2 User Configuration Options (/un#, /up#, /ulcp#) a. Setting User Name: Assigns a user name for the user ID #, where # is an index to the user table. The user ID1 is anonymous with user name set to NULL. User names can be 1 to 16 bytes in length. /un# syscfg /un# [user name] Example: Assign user name as "user" for the given user: syscfg /un2 user b. Setting User password: Sets or clears the password for the user with user ID #, where # is an index to the user table. /up# syscfg /up# [password] Examples: 1. Set the password for the given user as “t4x”: syscfg /up2 t4x 2. Clear the password for the given user: syscfg /up2 c. Configuring User Privilege Level: Sets the LAN channel privilege level for the user with user ID #. The privilege levels can be set using the following (not case sensitive) keywords: • USER • OPERATOR • ADMIN /ulcp# syscfg /ulcp# [privilege level] Examples: 1. Set the LAN channel privilege level for the given user to "OPERATOR": syscfg /ulcp2 OPERATOR 2. Set the LAN channel privilege level for the given user to "USER": syscfg /ulcp2 USER 3. Set the LAN channel privilege level for the given user to "ADMIN": syscfg /ulcp2 ADMIN 3.7 Firmware Advanced Features Configuration Interface 3.7.1 SMTP Alerting Interface a. /emailAlertEnable or /eae syscfg /eae "sender name" Example: syscfg /eae elvis b. /emailAlertConfig or /eac syscfg /eac "index" "parameter number" "send address or receive address or subject line" Example: syscfg /eac 1 1 server2@companyx.com c. /emailAlertMap or /eam syscfg /eam "channel ID" "lan alert destination index" "email alert index" Example: syscfg /eam 3 2 3 3.8 BIOS Configuration Interface (/bap, /bup, /bht, /bcr, /bqb, /bbo, /bcs) a. Setting BIOS Administrator Password: This switch sets the BIOS administrator password. The currently set password (old_password) must be specified to change or to clear the password. If the password is null, old_password should be specified as "" to signify a null password. If no new password is given, the old_password is verified against the current administrator password in the system. To clear the password new_password must be specified as "" to signify a null password. /bap syscfg /bap "old_password" "new_password" Examples: 1. Changes the BIOS administrator password from "admin" to "tt44". syscfg /bap admin tt44 2. The next example changes the BIOS admin password from null to "tt44". syscfg /bap "" tt44 3. The next example verifies the password "admin" with the current BIOS admin password syscfg /bap admin 4. The next example clears the BIOS administrator password from "btu8". syscfg /bap btu8 "" b. Setting BIOS User Password: This switch sets the user password. The currently set password (old_password) and the (new_password) must be specified to change the password. If the password is currently null, old_password should be specified as "" to signify a null password. To clear the password, (new_password) must be specified as "" to signify a null password. /bup syscfg /bup "old_password" "new_password" Example: 1. This example changes the BIOS user password to "Tf4r" to "bobT8": syscfg /bup Tf4r bobT8 2. Following example clears BIOS user password from "bobT8" syscfg /bup bobT8 "" c. Configuring Hyper-Threading enable status: /bht syscfg /bht "enable or disable" Example: The switch enables hyper-threading on the server: syscfg /bht enable d. Configuring console redirection parameters: Sets various settings related to console redirection. The possible values for each argument are listed below: • port : disable, COM1, or COM2 • baud_rate: 9600, 19200, 38400, 57600 or 115200 • flow_control : none or CTS • terminal_type: PCANSI, VT100, or VTUTF8 /bcr syscfg /bcr "port" "baud_rate" "flow_control" "terminal_type" Example: syscfg /bcr COM1 57600 CTS PCANSI e. Configuring Quiet Boot enable status. Determines whether the server boots using a quiet boot or not. Enable = quiet boot enabled. /bqb syscfg /bqb "enable or disable" Example: syscfg /bqb enable f. Displaying or Setting BIOS boot order. /bbo syscfg /bbo [dev 1] [dev 2] .. [dev n] syscfg /bbo Examples: 1. Displays the current BIOS boot order as a numbered list, with the first boot device appearing first in the list: syscfg /bbo 2. Sets the BIOS boot order so that the current second boot device is now the first boot device: syscfg /bbo 2 1 3 4 5 g. Set any configurable BIOS settings /bcs syscfg /bcs "Setting Name" [Value] Examples: 1. Displays the current BIOS Setting syscfg /d biossettings "Quiet Boot" 2. Sets the BIOS Setting value to 0000(Disable) syscfg /bcs "Quiet Boot" 0000 h. Set any configurable BIOS Group settings /bcs syscfg /bcs "Group Name" "setting Name1" [Value1] "setting Name2" [Value2] Examples: 1. Displays the current group BIOS Setting syscfg /d biossettings group "Serial Port Configuration" "Serial A Enable" "Address" "IRQ" 2. Sets the BIOS group Setting values syscfg /bcs "Serial Port Configuration" "Serial A Enable" 0001 "Address" 1016 "IRQ" 0004 0001--Enables Serial A 1016--Sets Address of Serila A to 3F8 0004--Sets IRQ of Serial A to 4. 3.9 System Configuration interface. The following are the new switches added as part of CCB 386. a. Restore firmware default factory settings syscfg /rfs b.Reset BMC syscfg /rbmc D. KNOWN ISSUES 1. System returns error message after executing syscfg BIOS commands for more than 20 times. Clear the NVRAM and restart the machine. Refer External# 22021. 2. 'bbo', help and display commands should be used standalone. 3. BIOS will override EFI Shell to first or last device if EFI Shell is set in any other position with the /bbo switch. 4. Save and restore across different OS is not supported. 5. SYSCFG help page will exit for any of the arrow keys. 6. S5000, S3000 and SC5400 a) "Quiet Boot" is not in sync with BIOS Setup. b) Use the legacy BIOS switches for the configuration of BIOS admin/user passwords, "restore defaults", "Console Redirection" and "Boot Order". c) " Clear Event Log" is not in sync with BIOS Setup. 7. S5000 and SC5400 a) "Legay IDE Channel" has 2 spaces before. b) "Processor Retest" has 1 trailing space. c) "Baud Rate", "Terminal type" and "Flow Control" parameters of "Serial Port B" for "Console Redirection" cannot be displayed/set through advanced bios configurations switch. d) "Resume on AC Power loss" and "FRB-2 Enable" changes are not reflected in the BIOS screen. e) "Clear System Event Log" not working. 8. S3000 a) The Group name "Hardware Health Configuration" in advance screen is differently dispalyed as "Hardware Monitor" after selection. b) PCI settings are not supported on S3000AH platforms 9. Setting time and Date using "/dt" is not supported. 10. When help is viewed using "syscfg /h", at the end of help, the prompt color changes to green. This scenario is not seen when help is interupted in between. E. OTHER NOTES * Third-party brands and names are the property of their respective owners. ======================================================== LEGAL INFORMATION ======================================================== Information in this document is provided in connection with Intel Products and for the purpose of supporting Intel developed server boards and systems. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted by this document. Except as provided in Intel's Terms and Conditions of Sale for such products, Intel assumes no liability whatsoever, and Intel disclaims any express or implied warranty, relating to sale and/or use of Intel products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right. Intel Corporation may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights that relate to the presented subject matter. The furnishing of documents and other materials and information does not provide any license, express or implied, by estoppel or otherwise, to any such patents, trademarks, copyrights, or other intellectual property rights. Intel products are not intended for use in medical, life saving, or life sustaining applications. Intel may make changes to specifications and product descriptions at any time, without notice. Intel is a registered trademark of Intel Corporation. *Other names and brands are the property of their respective owners. Copyright (c) 2007 Intel Corporation. (end)