Release Note for SYSCFG version 5.0.1 Build 7
October 10, 2008

Copyright (c) 2003-2008 Intel Corporation.

=======================================
Contents
---------

1.  Introduction
2.  System requirements
3.  Getting started
4.  Reference Documentation
5.  Known Issues
6.  OS limitations
7.  Platform Dependencies
8.  Legal Information

1. Introduction
-----------------
The Save and Restore System Configuration utility (syscfg) is 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.

2. System requirements
----------------------------------------------------------------------------------------------------------------
Supported                       Operating Systems/                                        BIOS Version                BMC Version
Platforms                        Preboot environment supported                              
                              
----------------------------------------------------------------------------------------------------------------
S5520HC,S5500BC            UEFI 2.0                                                        R019 and above           R0022 and above  
S5500SC, S5520UR           Win2k3 (32 bit)
S5500HCV                        Win2k3 (EM64T)            
                                         Win2k8 (32 bit)
                                        Win2k8 (EM64T)
                                        Win-PE Ver 2004 (Win XP SP2) 
                                        Win-PE Ver 2005 (Win 2003 SP1)
                                        Win-PE 2.0 (Win Vista, 32 bit)
                                        Win-PE 2.1 (Win Vista SP1
                                        or Windows 2008, EM64T)                                    
                                        RHEL5 Update 2 (32 bit)  
                                        RHEL5 Update 2 (EM64T)  
                                        SLES10 SP2 (32 bit) 
                                        SLES10 SP2 (EM64T)  
                                             
                                                       
-------------------------------------------------------------------------------------------------------------

IPMI 2.0 compliant S55xx platform series with Integrated BMC (IBMC).
                                              
 
3. Getting started
------------------
     I. Installation
        
        A. Linux
            a. Boot into Linux unzip the "syscfg-linux.zip",file into a folder on your hard drive. (e.g. c:\syscfg)
       
               The syscfg directory will have the following files.

                - installme
                - smi-2.0.2-1.i386.rpm
                - syscfg-3.0.2-6.i386.rpm
                - ReleaseNotes.txt
                - smi.c
                - smi.h
                - Makefile-2.4
                - Makefile-2.6

            b. Run the 'installme' script to install the 'syscfg' and 'smi' rpms.

            c. The SYSCFG utility will get installed in the path /usr/local/syscfg

            d. To uninstall SYSCFG run the following commands manually

                - rpm -e syscfg 
                - rpm -e smi
         
        B. UEFI
            a. Boot into EFI and copy the following files:

                - biosconfig.efi
                - BootDevice.efi
                - fwadvcfg.efi
                - iniparse.efi
                - ipmi.efi
                - lanconfig.efi
                - pefconfig.efi
                - powerconfig.efi
                - serialconfig.efi
                - solconfig.efi
                - syscfg.efi
                - systemconfig.efi
                - userconfig.efi
                - bioscfg.str
                - bootdev.str
                - fwadvcfg.str
                - HelpBmc.str
                - HelpMbmc.str
                - lancfg.str
                - pefcfg.str
                - powercfg.str
                - sercfg.str
                - solcfg.str
                - syscfg.str
                - system.str
                - usercfg.str
                - ReleaseNotes.txt

            b. Set the syscfg path variable SYSCFG_PATH. e.g:- set SYSCFG_PATH  fs0:\<syscfg_efi> where  
               syscfg_efi is the folder containing all the files mentioned above.

            c. Run 'syscfg' commands from the location where the files are copied as described in Section II.

            d. To uninstall SYSCFG run the following commands manually
        
                -Delete the contents of the directory where the utility is installed.

        C. Windows         

            a. Copy the .ZIP file into your local directory (e.g. C:\syscfg

            b. Unzip the folder

            c. Three subfolders will be seen under WinRelease folder. Those are -

                - Installation
                - InstallationEm64T
                - SysCfgRelease

            d. For 32bit platforms, go to Installation folder from the command prompt, run the Install.Cmd
               For 64bit platforms, go to InstallationEM64T folder from the command prompt, run the Install.Cmd

            e. The above command will install the respective drivers to be used by SysCfg utility
           
               Important Note: These drivers are yet to be digitally signed and will popup some Warning message.
                               Please click on "Yes" button in order to get the drivers installed. In Windows2008
                               platforms the OS should be booted with Advanced option "Do not enforce driver certification"         
        
            f. From the command prompt go to SysCfgRelease folder and run the desired commands for the utility
 

        II. Usage
            Format: syscfg <switch> <argument1> <argument2> ...

        Examples
        --------

          To save configuration to a binary or human editable(ini) format file.
    
          /save or /s
          Format:  syscfg /s [Filename or filetype] [/f][/b] 
          Example: syscfg /s 
                   syscfg /s "filename" 
                   syscfg /s "filename" /b
                   syscfg /s ini /b
                   syscfg /s ini /f
                   syscfg /s scf /f
                   syscfg /s scf /b
                       
          Restore configuration from a binary or human editable(ini) format file.
    
          /restore or /r
    
          Format:  syscfg /r [Filename or filetype] "/f" and/or "/b"
          Example: syscfg /r [Filename](optional) /f
                   syscfg /r [Filename](optional) /b
                   syscfg /r [Filename](optional) /f /b 
                   syscfg /r scf /b
                   syscfg /r ini /f
                   syscfg /r /f /b
                   syscfg /r /b
                   syscfg /r /f
    
          Displaying BIOS settings 

          /display bios or /d bios 

          Format:  syscfg /d bios 
          Example: syscfg /d bios
 
     

4. Reference Documentation
--------------------
  
    IPMI v2.0 specification
    SYSCFG Utility EPS 
    BIOS & FW External Product Specifications for the respective platforms

5. 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 UEFI Shell boot options to first or last device if UEFI Shell boot option 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. SYSCFG is not supported on VT Enable Kernel or OS.  

   7. When the save operation is performed on an existing file with the quite mode switch '-q', the file is overwritten without prompting the user.

   8. The settings under server management are saved in BMC. For some of the settings under server  
      management, after a reboot the values from BMC will override the values set through "bcs" switch.  

      The following settings will be overwritten 
                1. Resume on AC Power Loss
                2. FRB-2 Enable
                3. Clear System event log.

   9.  While using save restore functionality the file name length with extension plus file path length should not exceed 256 characters.

  10.  For proper display of help on Windows the cmd prompt window screen buffer size should have width fixed to 80 and height fixed to 300. 
       Also window size should have width fixed to 80 and height fixed to 25

    
6. OS limitations
--------------------
   1. On SUSE10 after reboot the utility needs to reinstall since SMI driver gets uninstalled after reboot. 

   2. Kernel sources needs to be installed in any flavor of Linux OSs. SMI Driver expects Kernel Sources to be built and installed in server.

   3. On Win2k8 (32 bit & EM64T) syscfg utility must be run with Administrator privileges. This can be done as explained below

       a. Select and right click on 'Command Prompt" icon. Select and left click on 'Run as administrator'.
          The User Account Control message window pops up.  Select and left click on 'Continue'. 
          The Administrator Command Prompt window appears.

       b. In the Administrator Command Prompt window execute the desired syscfg utility commands.


7. Platform Dependencies
----------------------------

   a. S55xx Platform series

      1. Serial channel related configuration settings are not supported. 
      2. Selected BIOS/FW settings are saved to INI file for more information refer to SysCfg EPS.
      3. For restoring purpose Un-editable Fields, Section Name Headers and Key Names should not be edited or deleted from the INI file
         If done so, the utility behaviour and error messages can be unpredictable.
      4. Some of the LAN settings like Default Gateway IP, Backup Gateway IP etc can be configured only after configuring Host IP and Subnet Mask IP. 
            
          
8. Legal Information
-----------------------
    
        
========================================================

                               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) 2003 - 2008 Intel Corporation.

(end)

