       Save and Restore System Configuration Utility Release Notes
              Copyright (c) 2003-2004 Intel Corporation
                        All Rights Reserved
                         February 23, 2004

The Save and Restore System Configuration utility (syscfg) is an EFI-based
program used for saving and restoring the Server Management (SM) Firmware (FW),
BIOS CMOS, and the EFI Boot Manager to and from binary files. This utility
also provides a set of command line options to configure server-specific FW and
BIOS settings.

RELEASE NOTES FOR SYSCFG UTILITY VERSION 1.1 Build 2

A. CHANGES SINCE PREVIOUS VERSION

   1. Added new commands to save and restore individual settings  FW, BIOS CMOS, 
      or EFI Boot Manager.

B. DEPENDENCIES 

   1. Requires BMC 22 and BIOS PR5.1 (165) or above for SR870BH2 servers with Madison
      Processors.
   2. Requires BMC 24 or above for SR870BN4 servers.
   3. Requires BIOS PR3.1 (912) or above for SR870BN4 servers with Madison Processors.
   4. Requires BIOS PR8.1 (913) or above for SR870BN4 servers with McKinley Processors.
   5. Executes under the EFI Shell Ver 0.99 or greater.
   6. A system reset is required for the restored settings to take effect.

C. SUPPORTED PLATFORMS

   1. SR870BH2
   2. SR870BN4

D. HOW TO USE THIS UTILITY

   1. Boot to the EFI shell.
   2. Copy the following files to HD:

      a. syscfg.efi
      b. ipmi.efi
      c. lanconfig.efi
      d. userconfig.efi

   3. Command line Interface

      3.1 General Usage:  syscfg [Options] [FileName]
      
      [FileName]   System Configuration file name.  It must be preceded by the
                   command line switch as described below.

      [Options]    Command line  switches defined below:
          /s            Writes the current system BIOS CMOS, Boot Manager, and
                        firmware settings to the specified binary file. If
                        no file name is specified, the default 'syscfg.scf'
                        file name is used.

                        This switch can be used with "/f", "/b", or "/e" option,
                        to save just one of the component settings instead of
                        all of them. Only one of those switches can be
                        specified with the "/s" option.

                        Examples:

                          1. Save the BIOS CMOS, EFI Boot Manager, and firmware
                             settings to the specified file.

                             syscfg /s myfile.scf

                          2. Save the BIOS CMOS settings to the specified file.

                             syscfg /s cmos.scf /c

                          3. Save the firmware settings to the specified file.

                             syscfg /s fw.scf /f

                          4. Save the EFI Boot Manager to the specified file.

                             syscfg /s efiboot.scf /e

          /r            This option restores the BIOS CMOS, EFI Boot Manager, or 
                        firmware settings from the specified file. It requires 
                        that the component being restored be specified with the 
                        options "/f", "/c", or "/e" for firmware, BIOS CMOS, or 
                        EFI Boot Manager, respectively. If no component is 
                        specified, this utility displays an error message and 
                        exits with an error code.

                        If no file name is specified, the default syscfg.scf file
                        name is used. If the file name is specified, then it should
                        come immediately after the switch "/r".

                        If there is a BIOS password installed in the system then 
                        the same password must be supplied in the command line using
                        the switch "/bap" along with the "/r" option. If the passwords 
                        dont match then the restore operation will fail and the utility 
                        will exit with an error message.

                        Examples:
                          1. Restore BIOS CMOS settings using the default file name.
                             No BIOS password exists in the system.

                             syscfg /r /c

                             syscfg /r /c /bap ""

         /i             Displays the header information contained in the specified
                        binary file. If no file name is specified, then system 
                        information is displayed.

                        Example:
                          1. Display the system information.

                                  syscfg /i

                          2. Display the binary file header information.

                                  syscfg /i syscfg.scf

        /f              This option is used in conjunction with "/s" or "/r" to save 
                        or restore the FW settings only.
                        
                        When restoring the FW settings, the input binary file 
                        must also contain the FW settings in order for this 
                        utility to restore them; otherwise, this utility displays
                        an error message and exits with an error code.

                        This option can not be used with "/c" or "/e" options.

        /c              This option is used in conjunction with "/s" or "/r" to save 
                        or restore the BIOS CMOS settings only.
                       
                        When restoring the BIOS CMOS settings, the input binary file
                        must also contain the BIOS CMOS settings in order for this 
                        utility to restore them; otherwise, this utility displays 
                        an error message and exits with an error code.

                        This option can not be used with "/f" or "/e" options.

        /e              This option is used in conjunction with "/s" or "/r" to save
                        or restore the EFI Boot Manager settings only.

                        When restoring the EFI Boot Manger settings, the input binary
                        file must also contain the EFI Boot Manger settings in order 
                        for this utility to restore them; otherwise, this utility displays 
                        an error message and exits with an error code.

                        This option can not be used with "/f" or "/c" options.

        /h Or /?        Displays the help information.

      3.2 Configuration Usage:  syscfg [Options] [Data]

        [Options]       Selects a parameter to be set with the data in [Data].
        /lde            DHCP enable.
        /lhi            BMC IP Address.
        /lsm            Subnet Mask.
        /lgi            Default Gateway IP Address.
        /lgm            Default Gateway MAC Address.
        /un#            Set User Name for user #; where # = 1 to n.
        /up#            Set User Password user #; where # = 1 to n.
        /ulcp#          Set LAN Channel Privilege Level for user #; where # = 1 to n.
        /bap            [Old Password] [New Password]
                        Sets or clears the BIOS password. The password
                        will be changed to [New Password] only if the [Old password]
                        matches with the password in the system.

        Examples:
          1. syscfg /lde 1                 : Enable DHCP
          2. syscfg /lhi 10.111.6.31       : Set BMC IP address
          3. syscfg /lsm 255.255.255.0     : Set Subnet Mask IP address
          4. syscfg /lgi 10.111.6.26       : Set Gateway IP address
          5. syscfg /lgm 0A-56-CF-06-11-02 : Set Gateway MAC address
          6. syscfg /un2 user              : Set User Name for user 2
          7. syscfg /up2 xyz               : Set User Password for user 2
          8. syscfg /ulcp2 ADMIN           : Set User Privilege level for user 2
          9. syscfg /bap 123 r12tk         : Set the BIOS administrator password 
                                             as "r12tk". Assume old password is 123.
         10. syscfg /bap 123 ""            : Clear the BIOS administrator password. 
                                             Assume old password is 123.

        The above command line options can be used in conjunction with the                 
        /r (restore) option. In this case, the utility restores everything                
        from the file first and it modifies the specified settings
        thereafter.

        If there is a BIOS password installed in the system then the same 
        password must be supplied in the command line using the switch "/bap" 
        along with the "/r" option. If the passwords dont match, then the 
        restore operation will fail and utility will exit with the error message.

        Examples:
          1. Restore firmware settings from given file and change the 
             IP address & subnet mask. No BIOS password exists in the
             system. Note that all the command line options and their 
             parameters are entered as a single command line in the 
             EFI shell environment.

             syscfg /r mycfgfile.scf /f /lhi 192.168.0.2 /lsm 255.255.255.0

          2. Restore BIOS CMOS settings from given file and change the 
             BIOS password to "abc" only if the existing password is "123".

                   syscfg /r mycfgfile.scf /c /bap 123 abc


E. LIST OF FILES REQUIRED TO RUN THE UTILITY

   1. syscfg.efi
   2. lanconfig.efi
   3. userconfig.efi
   4. ipmi.efi

F. KNOWN ISSUES

   None.

G. OTHER NOTES

   None.

*  Third-party brands and names are the property of their respective owners. 

(end)