System Configuration Utility Release Notes Copyright (c) 2003-2005 Intel Corporation All Rights Reserved April 21, 2005 The Save and Restore System Configuration utility (syscfg) is a DOS-based program used for saving and restoring FW and BIOS settings to a binary file, and for configuring FW and BIOS settings via a command line interface. RELEASE NOTES FOR THE SYSCFG UTILITY VERSION 1.0.3 A. CHANGES SINCE PREVIOUS VERSION This release is targetted at server configurations based on the PC87431 server management controller, Intel(R) Management Module - Professional Edition and Intel(R) Management Module - Advanced Edition. B. DEPENDENCIES 1. IPMI 1.5/2.0 systems or PC87431M-based systems. 2. ROM-DOS 6.22 3. The value of FILES field in the config.sys should not be less than 20. 4. Intel(R) Management Module - Advanced Edition required for advanced firmware feature configuration. 5. BIOS Version: Latest Approved for each Platform. 6. BMC version: Latest Approved for each Platform. 7. PC87431M FW version: 2.40 or higher. 8. Intel(R) Management Module Fab -4xx or above. 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. \enus\fwadvcfg\str\fwadvcfg.str k. \enus\lancfg\str\lancfg.str l. \enus\pefcfg\str\pefcfg.str m. \enus\powercfg\str\powercfg.str n. \enus\sercfg\str\sercfg.str o. \enus\solcfg\str\solcfg.str p. \enus\usercfg\str\usercfg.str q. \enus\bootdev\str\bootdev.str r. \enus\syscfg\str\syscfg.str s. \enus\syscfg\help\HelpMBmc.str t. \enus\syscfg\help\HelpBMC.str 3. Command line Interface Note: Serial, SOL, and FW Advanced Feature configuration options are not supported in PC87431M-based systems. Note: channel numbers used in the examples below may differ from the numbers to be used on a particular platform. Use the /channel option to display the valid channel numbers on a platform. 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, advancedfwcfg, channel, and bios. 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 Example: syscfg /s "filename" 3.3 Restore configuration from a binary file. /restore or /r Example: syscfg /r "filename" 3.4 FW Configuration Commands 3.4.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 SOL 3.4.2 POWER a. Power Restore Policy /powerrestorepolicy or /prp Format: syscfg /prp "power restore policy" Example: syscfg /prp OFF 3.4.3 Platform Event Filtering a. Global PEF configuration /pefconfig or /pefc Format: syscfg /pefc "global PEF state" "global control" Example: syscfg /pefc enable alert+reset 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.4.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 modem 19200 b. Modem settings /modemConf or /mc Format: syscfg /mc "Channel Id" "Modem Init String" "Modem Escape command" "Modem Hangup Command" "Modem Dial Command" "Ring Dead time" "Ring Duration" "System Phone Number" Example: syscfg /mc 4 ATE1Q0V1X4&D2&C1S0=0 +++ ATH ATD 3000 7000 5155224807 c. 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 d. Serial Page Enable /serialPageEnable or /spe Format: syscfg /spe "Channel ID" "Page Blackout Interval" "Community String" Example: syscfg /spe 4 3 “modem public” e. Serial Dial String /serialDialString or /sds Format: syscfg /sds "channel ID" "Dial String Index" "Dial String" Example: syscfg /sds 4 1 95154884627 f. 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 g. 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 5 Enable/Disable Modem enabled callback 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 9a Ring Dead time in 500ms increments 9b Ring Duration in 500ms increments 10 Modem Init string 11 Modem Escape command 12 Modem Hang-up command 13 Modem Dial command 14 Page Blackout Interval in minutes 15 Community String 18 Modem Call Retry Interval 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 192 System Phone Number. Example: syscfg /serialconf 4 2d none+straight+MD5+md2 Example: syscfg /serialconf 4 2d "" 3.4.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 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" Example: syscfg /lac 1 1 10.78.211.40 03-FE-EF-02-41-F3 disable disable 0 0 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 5 Host MAC Address 6 Subnet Mask IP Address 10 Enable/Disable Gratuitous ARP Enable 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 1 2c none+straight+md2+md5 Example: syscfg /lc 1 2d "" 3.4.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 1 LAN Disabled Admin syscfg /c "Channel ID" "Parameter Selector" "Value" Example: syscfg /c 1 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 9 PEF enable for the channel 3.4.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.5 Firmware Advanced Features Configuration Interface 3.5.1 HTTP/S Channel Configuration Interface /httpconfig or /hc syscfg /hc "http type" "channel ID" "http state" "port number" Example: syscfg /hc http 3 enable 80 syscfg /hc https 3 enable 443 3.5.2 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 /eae elvis syscfg /eam 3 2 3 3.5.3 Telnet Interface /telnetConfig or /tc syscfg /tc "channel ID" "telnet state" "port number" Example: syscfg /tc 3 enable 23 3.5.4 User Feature Interface /userfeature or /uf syscfg /uf "channel ID" "user ID" "telnet access" "http access" "https access" Example: syscfg /uf 3 1 enable enable disable 3.5.5 SNMP Interface /snmpConfig or /snc syscfg /snc "channel ID" "snmp state" "port number" Example: syscfg /snc 3 enable 161 3.5.6 KVM Interface /kvmconfig or /kc syscfg /kc "channel ID" "kvm state" "packet throttle" "frame throttle" "keyboard control policy" "keyboard timeout" Example: syscfg /kc 3 enable 2 2 1 120 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 BIOS, not from a 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 BIOS Configuration Interface (/bap, /bup, /bht, /bcr, /bqb, /bbo, /bhd) 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. 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 administrator password from null to "tt44". syscfg /bap "" tt44 3. The next example clears the BIOS administrator password from "btu8". syscfg /bap btu8 "" b. Setting BIOS User Password: This switch sets the BIOS user password. The currently set password (old_password) and the new password (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, CTS, XON (for XON/XOFF), or CTSCD • 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. Display or set the BIOS hard drive order; used for ordering hard drives to boot from. /bhd syscfg /bhd [drive 1] [drive 2] .. [drive n] syscfg /bhd Example: 1. Sets the BIOS hard drive order so that the second hard drive becomes the first hard drive from which booting is attempted: syscfg /bhd 2 1 D. KNOWN ISSUES 1. The valid index for configuring a alert destination using the /lac option on PC87431M-based systems should be 1 but is currently 0. 2. The format of a file specified for restoring a configuration is not currently checked. 3. On string arguments, missing quotation marks used to enclose a string may not be detected correctly. 4. The /s switch does not support relative path locations (e.g. ..\myfile.scf). 5. HTTPS configuration is not currently supported by the firmware. The utility will have the following limitations due to this : a. Utility will report error if HTTPS configuration is attempted using /hc switch. b. HTTPS state switch will be ignored in /uf and utility will continue with configuration of telnet and HTTP. c. HTTPS enable / disable setting for per user will not be saved and restored by the utility. * Third-party brands and names are the property of their respective owners. (end)