background image

CP6004-SA/-RA/-RC/CP6004X-SA

The uEFI Shell

ID 1053-6161, Rev. 3.0

Page 57

D R A F T   —   F O R   I N T E R N A L   U S E   O N L Y

6.2.5

kbootnsh uEFI Shell Command 

6.2.6

kclearnvram uEFI Shell Command

kbootnsh 

FUNCTION:

Manage the startup script stored in the flash

SYNTAX:

kbootnsh [-b][-?|-g <filename>|-p <filename>|-d]

where:

-b

Display output page by page

-?

Show online help

-g <filename>

Store the current boot script to disk. If there is no phys-
ical disk drive present, the

 kmkramdisk

 command 

may be used.

-p <filename>

Store the shell script pointed to by filename to flash.

Note: The shell script cannot be larger then 400 bytes.

-d

Delete the current startup script from flash.

DESCRIPTION:

The 

kbootnsh

 command manages the flash stored startup script. If the 

shell is launched by the boot process, it executes a shell script stored in 
the flash. If the shell script terminates, the shell executes a

 kboot -d 

command to continue the boot process. However, the shell script can of 
course contain any other boot command.

USAGE:

Get current startup script to file named boot.nsh

COMMAND / RESPONSE EXAMPLE:

Shell> kbootnsh -g boot.nsh

Store file named boot.nsh to flash:

COMMAND / RESPONSE EXAMPLE:

Shell> kbootnsh -p boot.nsh

Delete startup script:

COMMAND / RESPONSE EXAMPLE:

Shell> kbootnsh -d

kclearnvram

FUNCTION:

Clear the NVRAM to restore the system’s default settings

SYNTAX:

kclearnvram

No parameters required. For safety reasons this command must be con-
firmed by pressing “c”.

DESCRIPTION:

The 

kclearnvram

 command allows to clear the system NVRAM. Since 

all uEFI settings are stored inside the NVRAM, the default settings are 
loaded afterwards.

Summary of Contents for CP6004-RA

Page 1: ...If it s embedded it s Kontron User Guide D R A F T F O R I N T E R N A L U S E O N L Y CP6004 SA CP6004 RA CP6004 RC CP6004X SA uEFI BIOS Doc ID 1053 6161 Rev 3 0 August 13 2013...

Page 2: ...ot guaranteed for legal purposes Information has been carefully checked and is believed to be accurate however no responsibility is assumed for inaccuracies Kontron and the Kontron logo and all other...

Page 3: ...1 TPM Support 10 2 2 1 2 TPM State 11 2 2 2 Pending TPM Operation 11 2 2 3 Current TPM Status Information 11 2 3 CPU Configuration 12 2 3 1 CPU Configuration 12 2 3 2 Max Freq Ratio 12 2 4 Firmware Up...

Page 4: ...d frequency Minimum supported frequency etc 23 2 7 2 New SSC Mode 23 2 7 3 New SSC spread percentage 23 2 7 4 Apply settings immediately 24 2 7 5 Apply settings permanently after reboot 24 2 8 System...

Page 5: ...Defaults Save Options 38 5 8 Save as User Defaults Save Options 38 5 9 Restore User Defaults Save Options 38 5 10 Boot Override 38 6 The uEFI Shell 41 6 1 Introduction Basic Operation 41 6 1 1 Shell...

Page 6: ...f Startup Scripts 66 6 3 3 1 Automatic Booting from USB Flash Drive 66 6 3 3 2 Switch On Clock Spreading Prior to Booting from Harddrive 66 6 3 3 3 Execute Shell Script on Other Harddrive 66 6 3 3 4 E...

Page 7: ...CP6004 SA RA RC CP6004X SA Starting uEFI BIOS Setup ID 1053 6161 Rev 3 0 Page 1 Starting uEFI BIOS Setup Chapter 1 1 D R A F T F O R I N T E R N A L U S E O N L Y...

Page 8: ...Starting uEFI BIOS Setup CP6004 SA RA RC CP6004X SA Page 2 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 9: ...individual function settings for control or modification of the uEFI BIOS configuration and a Set up program which allows the accessing of various menus that provide functions or access to sub menus w...

Page 10: ...at can be configured They are displayed in blue Functions displayed in gray provide information about the status or the operational configuration The right frame displays the key legend Above the key...

Page 11: ...o save the current settings and exit the uEFI BIOS Setup Right Left The Right and Left Arrow keys are used to select a major Setup screen For example Main Screen Advanced Screen Chipset Screen etc Up...

Page 12: ...Starting uEFI BIOS Setup CP6004 SA RA RC CP6004X SA Page 6 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 13: ...CP6004 SA RA RC CP6004X SA Main Setup ID 1053 6161 Rev 3 0 Page 7 Main Setup Chapter 1 2 D R A F T F O R I N T E R N A L U S E O N L Y...

Page 14: ...Main Setup CP6004 SA RA RC CP6004X SA Page 8 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 15: ...version is reflected in the display only function Project Version parameter 14 00 indicates revision 14 Aptio Setup Utility Copyright C 2010 American Megatrends Inc Main Boot Security Save Exit BIOS...

Page 16: ...ility Copyright C 2010 American Megatrends Inc Main Boot Security Save Exit TPM Configuration TPM Support Enable TPM State Enabled Pending TPM Operation None Current TPM Status Information TPM Enabled...

Page 17: ...e this setting to prevent the system from issuing any TPM commands Enable Take Ownership Use this setting to allow the system to issue an Enable Take Ownership command during the next boot If this set...

Page 18: ...ke a reduction in power consumption possible when higher performance is not required To ensure that the maximum desired frequency is not exceeded the CPU turbo mode must be disabled using the uEFI she...

Page 19: ...disabled for the next boot However after the next boot this function shows Disabled Default setting Disabled Aptio Setup Utility Copyright C 2011 American Megatrends Inc Main Boot Security Save Exit...

Page 20: ...d some BootLoaders Default setting Enabled Aptio Setup Utility Copyright C 2011 American Megatrends Inc Main Boot Security Save Exit USB Configuration USB Devices 1 Keyboard 1 Mouse 4 Hubs Legacy USB...

Page 21: ...reports itself to the Host Controller Auto uses a default value for a Root port it is 100 ms for a Hub port the delay is taken from Hub descriptor If the Manual option is chosen the device power up d...

Page 22: ...2 6 1 1 Console Redirection Default setting Enabled 2 6 1 2 Console Redirection Settings For information about this function refer to Chapter 2 6 2 2 in this manual Aptio Setup Utility Copyright C 201...

Page 23: ...dently configured SETTING DESCRIPTION Disabled Use this setting to disable console redirection for COMB RS 232 Enabled Use this setting to enable console redirection for COMB RS 232 Aptio Setup Utilit...

Page 24: ...RIPTION VT100 Use one of these settings to select the terminal type to be emulated VT100 VT UTF8 ANSI SETTING DESCRIPTION 9600 Use one of these settings to select the baud rate of the serial port 1920...

Page 25: ...OS Redirection Default setting 80x24 SETTING DESCRIPTION None Use one of these settings to specify the type of flow control to be used for this serial port Hardware RTS CTS SETTING DESCRIPTION Disabl...

Page 26: ...console output 2 6 3 1 Console Redirection Default setting Disabled SETTING DESCRIPTION VT100 Use one of the available settings to select the Function Key and the KeyPad when using Putty as terminal p...

Page 27: ...TF8 Aptio Setup Utility Copyright C 2011 American Megatrends Inc Main Boot Security Save Exit Serial Port for Out of Band Management Console Redirection Settings Out of Band Mgmt Port COM0 Terminal Ty...

Page 28: ...anagement 2 6 3 2 6 Parity This is a display only function providing information about the parity for Out of Band Manage ment 2 6 3 2 7 Stop Bits This is a display only function providing information...

Page 29: ...e setting may lead to system instability 2 7 3 New SSC spread percentage Use this function to specify the requested Spread Spectrum Clock SSC in 0 01 increments Default setting 50 Aptio Setup Utility...

Page 30: ...5 30 A M appears as 05 30 00 and 5 30 P M as 17 30 00 2 11 Access Level This function provides display only information concerning the uEFI BIOS Setup accessibility for the current Setup session The...

Page 31: ...CP6004 SA RA RC CP6004X SA Boot Setup ID 1053 6161 Rev 3 0 Page 25 Boot Setup Chapter 1 3 D R A F T F O R I N T E R N A L U S E O N L Y...

Page 32: ...Boot Setup CP6004 SA RA RC CP6004X SA Page 26 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 33: ...Exit Boot Configuration Setup Prompt Timeout 1 Bootup NumLock State On Quiet Boot Disabled Fast Boot Disabled CSM16 Module Version 07 68 GateA20 Active Upon Request Option ROM Messages Force BIOS Int...

Page 34: ...n provides display only information concerning the CSM Module and is intended for internal use only 3 1 6 GateA20 Active This function is used to enable or disable GateA20 Default setting Upon Request...

Page 35: ...elect the BBS class uEFI boot entry desired 3 2 2 Hard Drive Network Device CD DVD ROM Drive Floppy Drive BEV Device BBS Priorities These functions lead to sub menus that allow configuring the boot or...

Page 36: ...Boot Setup CP6004 SA RA RC CP6004X SA Page 30 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 37: ...CP6004 SA RA RC CP6004X SA Security Setup ID 1053 6161 Rev 3 0 Page 31 Security Setup Chapter 1 4 D R A F T F O R I N T E R N A L U S E O N L Y...

Page 38: ...Security Setup CP6004 SA RA RC CP6004X SA Page 32 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 39: ...ge Minimum length 3 Maximum length 20 Administrator Password User Password HDD Security Configur HDD 0 ST9120822SB Select Screen Select Item Enter Select Change Opt F1 General Help F2 Previous Values...

Page 40: ...er it twice and acknowledge by pressing Re turn Note The password is case sensitive 4 3 HDD Security Configuration This function is not fully supported on the CP6004 SA RA RC CP6004X SA Warning Before...

Page 41: ...CP6004 SA RA RC CP6004X SA Save Exit ID 1053 6161 Rev 3 0 Page 35 Save Exit Chapter 1 5 D R A F T F O R I N T E R N A L U S E O N L Y...

Page 42: ...Save Exit CP6004 SA RA RC CP6004X SA Page 36 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 43: ...tup This function continues the boot process Note The Setup will ask for confirmation prior to executing this command 5 3 Save Changes and Reset This function is used to save all changes made within t...

Page 44: ...mmand 5 7 Restore Defaults Save Options This function is used to restore all tokens to factory default Note The Setup will ask for confirmation prior to executing this command 5 8 Save as User Default...

Page 45: ...CP6004 SA RA RC CP6004X SA The uEFI Shell ID 1053 6161 Rev 3 0 Page 39 The uEFI Shell Chapter 1 6 D R A F T F O R I N T E R N A L U S E O N L Y...

Page 46: ...The uEFI Shell CP6004 SA RA RC CP6004X SA Page 40 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 47: ...the board as usual 6 1 1 Shell Startup If the shell is executed it displays its signon message followed by a list of detected devices The output produced by the device mapping table can vary depending...

Page 48: ...tron system kBiosRevision kboardconfig kboardinfo kboot kbootnsh kclearnvram kflash kipmi kmkramdisk kpassword kresetconfig kwdt The following chapters provide information concerning these Kontron spe...

Page 49: ...current uEFI BIOS revision is greater than number number uEFI BIOS revision number DESCRIPTION The kBiosRevision command is used to display the current uEFI BIOS revision In scripting environments it...

Page 50: ...t status kboardconfig b lists options their current status and in vokes page breaks in the display output kboardconfig nc lists options their current status and dis ables color in the display output k...

Page 51: ...splay auto Vga front SataMode ahci Sata0Speed Gen3 Sata1Speed Gen3 Sata2Speed Gen2 Sata3Speed Gen2 Sata4Speed Gen2 Sata5Speed Gen2 Sata0Hotplug disabled Sata1Hotplug disabled Sata2Hotplug disabled Sat...

Page 52: ...olatile board settings Example kboardconfig option parameter Show all options and their current status kboardconfig Show help kboardconfig Show all options and their current status with page break kbo...

Page 53: ...COMMAND RESPONSE EXAMPLE CP6004X SA Shell kboardconfig Pxe Pxe PXE boot device Available parameters disabled all gbe_a gbe_b rear_a rear_b gbe_e 10gbe_1 10gbe_2 In this case disabled is the current se...

Page 54: ...X SA Gigabit Ethernet available on the front panel GbE B port gbe_b CP6004 RA Gigabit Ethernet available on the front panel GbE B port or on the rear I O LPd port gbe_b CP6004 RC Gigabit Ethernet avai...

Page 55: ...ted During the bootup it is possible to select a menu to specify the desired RAID configuration Entry to this menu is achieved by pressing Ctrl I when requested during the bootup Sata0Speed Indicates...

Page 56: ...select onboard SATA flash write protection If enabled the onboard SATA flash is write protected after POST OS needs to be prepared to work with write protected flash For further information refer to t...

Page 57: ...oncentrated form USAGE Show board identification data COMMAND RESPONSE EXAMPLE CP6004 SA Shell kboardinfo KOMaOEMF rev 4 Board ID 0xB3D0 Hardware rev 0x0 Logic rev 0x1 Boot flash Standard SPI boot fla...

Page 58: ...t flash Standard SPI boot flash In system slot No Geographic address 8 Material number Hardware index Serial number EFI article name SK EFI B3D01 EFI material number 1052 6900 EFI index 14 standard EF...

Page 59: ...t flash Standard SPI boot flash In system slot No Geographic address 8 Material number Hardware index Serial number EFI article name SK EFI B3D01 EFI material number 1052 6900 EFI index 14 standard EF...

Page 60: ...t flash Standard SPI boot flash In system slot No Geographic address 8 Material number Hardware index Serial number EFI article name SK EFI B3D01 EFI material number 1052 6900 EFI index 14 standard EF...

Page 61: ...e slot the board is currently plugged into Material number Kontron hardware reference number Hardware index Kontron hardware index Serial number This board s unique serial number EFI article name Kont...

Page 62: ...boot returns to shell The kboot command cannot boot native uEFI aware operating systems But since these are bootable from shell by calling their bootloader this is not necessary either If a requested...

Page 63: ...sh stored startup script If the shell is launched by the boot process it executes a shell script stored in the flash If the shell script terminates the shell executes a kboot d command to continue the...

Page 64: ...ash banks holding the uEFI BIOS code uEFI BIOS binary files must be available from connected mass storage devices such as USB flash drive or harddisk USAGE Get help COMMAND RESPONSE EXAMPLE Shell kfla...

Page 65: ...ngs sel handle system event log sensor show sensor related information raw execute raw ipmi command rawsendmessage execute raw SendMessage ipmi cmd info show information about the device and firmware...

Page 66: ...ID Displays FRU data Options Fru device ID Numeric FRU device ID The FRU ID 0 is used by default if no FRU ID is entered ipmb Displays IPMB bus settings ipmb redundant Switch IPMB bus to redundant mod...

Page 67: ...how board sensor data Options list Display an overview of all available board sensors read Display specific sensor data raw bytes Execute raw IPMI command Syntax raw NetFn LUN COMMAND rawsendmessage b...

Page 68: ...nnected to the system Note The RAMdisk loses its mount point name after all drives are remapped by the map r command The RAMdisk will then be enumerated as any other connected drive and gain a mount p...

Page 69: ...d scripting n New password to be set Use together with options u or s o Submit password if one is already set Use together with options u or s When used with out the option n the password is cleared N...

Page 70: ...PCI backplane reset if it is used as slave board in a peripheral slot It has no effect if the board is located within a CPCI mas ter slot Note This parameter is volatile and at next start is set to of...

Page 71: ...s required for this functionality to operate USAGE Get help COMMAND RESPONSE EXAMPLE Shell kwdt t time set Timer value 0 125ms value 1 250ms value 2 500ms value 3 1s value 4 2s value 5 4s value 6 8s v...

Page 72: ...OS with a plain text editor of your choice To create a startup shell script simply save the script on any FAT formatted drive attached to the system under the file name efi boot startup nsh To copy t...

Page 73: ...hows two uEFI Shell environment variables wdt_enable and pxe_first used to control the boot process and the Watchdog To create uEFI Shell environment variables use the set uEFI Shell command as shown...

Page 74: ...and set the proper working directory as shown below 6 Enter the sample start up script mentioned above in this section using the edit uEFI Shell command 7 Save the start up script to the uEFI flash b...

Page 75: ...CP6004 SA RA RC CP6004X SA Updating the uEFI BIOS ID 1053 6161 Rev 3 0 Page 69 Updating the uEFI BIOS Chapter 1 7 D R A F T F O R I N T E R N A L U S E O N L Y...

Page 76: ...Updating the uEFI BIOS CP6004 SA RA RC CP6004X SA Page 70 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Page 77: ...ting or cloning the uEFI BIOS ensure that the ME FW Image Re Flash function in the Main Setup menu is set to Enable refer to Chapter 2 4 1 for further information Failure to comply with the above may...

Page 78: ...Updating the uEFI BIOS CP6004 SA RA RC CP6004X SA Page 72 ID 1053 6161 Rev 3 0 D R A F T F O R I N T E R N A L U S E O N L Y This page has been intentionally left blank...

Reviews: