Hp Unified Extensible Firmware Interface User Manual

HP UEFI Shell User Guide for HP ProLiantDL580 Gen8 ServersAbstractThis document details how to access and use the Unified Extensible Firmware Interfac

Figure 5 Boot Options — UEFI Boot Order screenBooting to the UEFI ShellYou can select the UEFI Shell for a one-time boot override whenever necessary.

Figure 6 One-Time Boot menu screenFigure 7 UEFI Shell Prompt screenAccessing the UEFI Shell from a serial console connectionNOTE: When accessing the S

Procedure 11. Boot the server as explained in “Booting to the UEFI Shell” (page 10).2. Open a connection in an SSH client application using the server

2 UEFI Shell command referenceCommand line syntaxTable 1 (page 13) lists examples of how to interpret command syntax.Table 1 Syntax examplesUsageSynta

Controlling command outputMany UEFI Shell commands support optional parameters for controlling how the output displayson the screen. The following sec

Example 2 Using -b to display output one screen at a time Shell> devtree -bCtrl[03] Fv(6522280D-28F9-4131-ADC4-F40EBFA45864) Ctrl[04] Fv(770BF9B6-8

Example 4 Using -v to display detailed outputShell> dh -v -b01: LoadedImage02: Decompress03: UnknownDevice DevicePath Fv(6522280D-28F9-4131-ADC4-F4

Example 6 Using -q to suppress the confirmation prompt fs0:\> rm -q test\temp*removing fs0:\test\temp1\temp1.txt - [ok]removing fs0:\test\temp1\boo

Example 8 Displaying help for the ls commandShell> help ls -bLists a directory's contents or file information.LS [-r] [-a[attrib]][-sfo][file]

Example 9 Displaying help for commands beginning with aShell> help a*Displays, creates, or deletes UEFI Shell aliases.ALIAS [-d|-v] [alias-name] [c

© Copyright 2014 Hewlett-Packard Development Company, L.P.NoticesConfidential computer software. Valid license from HP required for possession, use or

directory: fs0:\> attrib * * To add the system attribute to all files with extension '.efi': fs0:\> attrib +s *.efi * To r

Syntaxalias [ -d | -v ] [alias-name] [command-name]Options-d Deletes an alias. The command-name option should not be present.-v Makes the alias volati

[ +s | -s ] Sets or clears the system attribute.[ +h | -h ] Sets or clears the hidden attribute.[ +r | -r ] Sets or clears the read-only attribute.fil

DescriptionThis command changes the current working directory that is used by the UEFI Shell environment.If a file system mapping is specified, then t

0—Black1—Blue2—Green3—Cyan4—Red5—Magenta6—Yellow7—Light grayDescriptionThis command clears the standard output device with an optional background colo

fs0:\> comp bios.inf bios2.infCompare fs0:\bios.inf to fs0:\bios2.inf Difference #1:File1: fs0:\bios.inf 00000000: 5F *_* File2: fs0:\bios2.inf

06/13/01 10:00a 32,838 IsaSerial.efi 06/18/01 08:04p 29 temp.txt 06/18/01 08:05p <DIR> 512 test 3 File(s) 61,606

DescriptionThis command displays or sets the current date for the system. If no parameters are used, it showsthe current date. If a valid month, day,

fs0:\> dblk fs0 2To display 0x5 blocks of fs0, beginning from block 0x12:fs0:\> dblk fs0 12 5devicesDisplays a list of devices managed by UEFI d

Table 5 Output details—devices command (continued)Displays the...ColumnConfiguration Protocol support status:CFG• Y—Yes• N—NoDiagnostics Protocol supp

Contents1 Introduction...5Commands and capabilities...

Ctrl[19F] PciRoot(0x0)/Pci(0x4,0x0) Ctrl[1A0] PciRoot(0x0)/Pci(0x4,0x1) Ctrl[1A1] PciRoot(0x0)/Pci(0x4,0x2) Ctrl[1A2] PciRoot(0x0)/Pci(0x4,0x

ROM Location..: 00000000 ISA Resource List : IO : 000003F8-000003FF Attr : 00000000 INT : 00000004-00000000 Attr : 00000000 dpath

Options-b Displays one screen at a time.address Displays memory contents from a specific starting address (in hexadecimal format).size Displays memory

49 00000010 ? - - - - ISA Serial Driver IsaSerial4C 00000010 B - - 1 1 PCI Bus Driver PciBus55 000000

ExamplesTo display a message string of Hello World:fs0:\> echo Hello WorldHello WorldTo turn command echoing on:fs0:\> echo -onTo execute HelloW

fs0:\> eficompress uncompressed compressedefidecompressDecompresses a file using the EFI Decompression Algorithm.Syntaxefidecompress infile outfile

DescriptionThis command updates the system BIOS firmware. Optionally, specify an NVRAM reset, a rebootafter the flash, or both. If no options are spec

command-name is the name of the shell command. The files follow a subset of the MAN pageformat, as described below.If no option is specified, then onl

DescriptionThis command lists directory contents or file information. If no file name or directory name isspecified, then the current working director

1 File(s) 29 bytes 0 Dir(s)To display files with an attribute of s:fs0:\> ls -as isabus.efi Directory of: fs0:\ 06/18/01 10:59p

memmap...41mkdir...

Table 9 Output details—ls command (file information) (continued)Displays the...ColumnTime when the file was modified, in the format: hh:mm:ssFile Modi

The -r option resets all the default mappings in a system. It is useful if the system configurationhas changed since the last boot.The –u option adds

Type Start End # Pages Attributes available 0000000000750000-0000000001841FFF 00000000000010F2 0000000000000009LoaderCode

Table 11 Output details—memmap command (continued)Displays the...ColumnAvailable memory in bytesavailableTotal memory size in bytesTotal MemorymkdirCr

DescriptionThis command is used to change the display mode for the console output device. When usedwithout any parameters, it shows the list of modes

fs0:\> mv IsaBus.efi Bus.efimoving fs0:\IsaBus.efi -> \Bus.efi - [ok]openinfoDisplays the protocols and agents associated with a handle.Syntaxop

Syntaxpause [-q]DescriptionThis command is available only in scripts. It prints a message to the display, and then suspendsscript file execution and w

-Bus Bus numberDev Device numberFunc Function numberDescriptionThis command displays all the PCI devices in the system. It can also display the config

Options-q Deletes in quiet mode, without displaying a confirmation prompt.file Specifies the file name to be deleted. Wild cards are permitted.directo

setDisplays, changes, or deletes a UEFI Shell environment variable.Syntaxset [-v] [sname [value]]set [-d sname]Options-v Sets a volatile variable that

1 IntroductionThe system BIOS in all HP ProLiant DL580 Gen8 servers includes an embedded UEFI Shell in theROM. Based on the UEFI Shell Specification t

Shell> set * path : .;fs0:\efi\tools;fs0:\efi\boot;fs0:\To set a volatile variable that disappears at the next boot:Shell> set -v EFI_SOUR

fs0:\> echo -off shift.nsh> shift.nsh welcome EFI world welcome EFI world EFI world smbiosviewDisplays SMBIOS information.Syntaxsmbiosview [-t S

Options-i Shows information for the specified settings or all settings, including possiblevalues.settingname Specifies a setting name about which to d

SerialConsoleBaudRate=115200EmsConsole=DisabledRomSelection=CurrentRomNmiDebugButton=EnabledVirtualInstallDisk=DisabledPciBusPadding=EnabledPowerOnLog

Shell> sysconfig -s uefibootorder=11Change UEFI boot order successfully!sysconfig attributesFor more information, see HP UEFI System Utilities User

Table 12 Sysconfig Settings (continued)Possible ValuesDescriptionSetting NameEnablednlEmbedded UEFI ShellEmbeddedUefiShellDisabledEnablednlAdd Embedde

Table 12 Sysconfig Settings (continued)Possible ValuesDescriptionSetting NameMaxSupported [Maximum SupportednlMaximum PCI Express SpeedMaxPcieSpeedPci

Table 12 Sysconfig Settings (continued)Possible ValuesDescriptionSetting NameHiddennlTPM VisibilityTpmVisibilityVisibleAutonlBIOS Serial Console PortS

Table 12 Sysconfig Settings (continued)Possible ValuesDescriptionSetting NamenlIPv6ThenIPv4 [IPv6 then IPv4]Default [Default Power SupplyRequirements]

Table 12 Sysconfig Settings (continued)Possible ValuesDescriptionSetting NameEnablednlProcessor X2Apic SupportProcessorX2ApicSupportDisabledEnablednlA

Figure 1 HP ProLiant POST screen3. To navigate through and modify settings in the menu-driven interface, use the keys defined inthe following table.Ac

Table 12 Sysconfig Settings (continued)Possible ValuesDescriptionSetting NamenlUtcP430 [UTC+04:30, Kabul]nlUtcP5 [UTC+05:00, Ekaterinburg,Islamabad, K

NOTE:• Except for numeric characters and the : (colon) character, all other characters in the argumentare invalid. The Shell reports an error if the n

Syntaxtouch [-r] file [file...]Options-r Makes the update recursive into subdirectories.file Specifies the name or pattern of the file or directory to

Syntaxver [ -s | -t ]Options-s Displays only the UEFI Shell version.-t Displays summary (terse) content.DescriptionThis command displays the version i

shell> vol fs0 –n help_testVolume HELP_TEST (rw) 1,457,664 bytes total disk space 1,149,440 bytes available on disk 512 bytes in each allocation un

3 Running and editing UEFI Shell scriptsThe following information describes the scripting functions provided by the UEFI Shell.UEFI Shell script comma

clsset -v myfs 0if exist FS0:\* thenFS0:echo "FS0:\ Found!"goto FSFOUNDendifecho "FS0:\ not found in system"echo "Going to se

sysconfig -import sysconfig_backup.txtendif:ENDset -d myfsSample Shell scripts 67

4 Using the UEFI Programming ModelThe UEFI Shell provides a programming API. You can use it to write your own UEFI applicationsfor calling some of the

Table 13 UEFI Application APIs (continued)DescriptionFunction NameFunction TypeGets the enable status of the page breakoutput mode.GetPageBreakEFI_SHE

ActionKeyPress during server POST or system reboot to display the SystemUtilities screen in the iLO 4 Remote Console.F9Press during server POST to boo

Examplefs0:\> /** @file This is an example Shell Application. Note that there are other ways to add a command to the shell. This example demon

Print (L"ENVIRONMENT VARIABLES:\n"); Print (L"\n"); // // Sample to get and display all environment variables //

5 UEFI Shell command status codesTable 14 (page 72) lists the possible status codes displayed by the UEFI Shell when you issue acommand. Codes vary de

6 Support and other resourcesContacting HPFor worldwide technical support information, see the HP Support Center:http://www.hp.com/go/hpscBefore conta

Table 15 Document conventions (continued)ElementConventionWebsite addressesBlue, underlined text: http://www.hp.comBold text• Keys that are pressed• T

from you, an authorized HP Channel Partner can also view your IT environment remotely by usingHP Insight Online.For more information, see the followin

7 Documentation feedbackHP is committed to providing documentation that meets your needs. To help us improve thedocumentation, send any errors, sugges

GlossaryACR Array Configuration Replication UtilityASR Automatic Server RecoveryBIOS Basic Input/Output SystemCLI Command Line InterfaceCNA Converged

IndexAaccessing a file system, 20accessing the UEFI Shell, 5accessing the UEFI shell from a serial console connection,11application APIs, 68Bboot orde

Status code meanings, 72UEFI Shell command status codesstatus codes, 72UEFI Shell commands, 20alias, 20attrib, 21cd, 22cls, 23comp, 24cp, 25date, 26db

Enabling the Embedded UEFI ShellYou can enable or disable the Embedded UEFI Shell. The UEFI Shell is a pre-boot command lineenvironment for scripting

To add the Embedded UEFI Shell to the boot order list:1. From the System Utilities screen, select System Configuration→BIOS/Platform Configuration(RBS