====== Command reference ======

{{ :screenshots:cmdline.png?240x133|iPXE command line}}

The following commands are supported by iPXE.  Commands may be entered at the iPXE [[:cmdline|command line]] or used in a [[:scripting|script]].

^ Boot commands                                                                              ||
^ ''[[:cmd:autoboot]]''    | Boot system from network interface                               |
^                                                                                            ||
^ Network interface commands                                                                 ||
^ ''[[:cmd:ifstat]]''      | Display interfaces                                               |
^ ''[[:cmd:ifopen]]''      | Open interfaces                                                  |
^ ''[[:cmd:ifclose]]''     | Close interfaces                                                 |
^ ''[[:cmd:ifconf]]'' or\\ ''[[:cmd:dhcp]]''  | Automatically configure interfaces            |
^ ''[[:cmd:iflinkwait]]''  | Wait for link-up                                                 |
^ ''[[:cmd:route]]''       | Display routing table                                            |
^ ''[[:cmd:nstat]]''       | Display neighbour table                                          |
^ ''[[:cmd:ipstat]]''      | Display IP statistics                                            |
^ ''[[:cmd:vcreate]]''     | Create VLAN                                                      |
^ ''[[:cmd:vdestroy]]''    | Destroy VLAN                                                     |
^                                                                                            ||
^ Image management commands                                                                  ||
^ ''[[:cmd:imgstat]]''     | Display images                                                   |
^ ''[[:cmd:chain]]'' or\\ ''[[:cmd:imgexec]]'' or\\ ''[[:cmd:boot]]''  | Download and boot an executable image  |
^ ''[[:cmd:imgfetch]]'' or\\ ''[[:cmd:module]]'' or\\ ''[[:cmd:initrd]]''  | Download an image  |
^ ''[[:cmd:kernel]]'' or\\ ''[[:cmd:imgselect]]'' or\\ ''[[:cmd:imgload]]''  | Download and select an executable image  |
^ ''[[:cmd:imgfree]]''     | Discard images                                                   |
^ ''[[:cmd:imgargs]]''     | Set image command-line arguments                                 |
^ ''[[:cmd:imgtrust]]''    | Set image trust requirement                                      |
^ ''[[:cmd:imgverify]]''   | Verify an image as trusted                                       |
^ ''[[:cmd:imgdecrypt]]''  | Decrypt an encrypted image                                       |
^ ''[[:cmd:imgextract]]''  | Extract a compressed or archive image                            |
^ ''[[:cmd:shim]]''        | Configure UEFI shim image                                        |
^                                                                                            ||
^ SAN commands                                                                               ||
^ ''[[:cmd:sanhook]]''     | Attach SAN device                                                |
^ ''[[:cmd:sanboot]]''     | Boot from SAN device                                             |
^ ''[[:cmd:sanunhook]]''   | Detach SAN device                                                |
^ ''[[:cmd:fcstat]]''      | Display Fibre Channel ports                                      |
^ ''[[:cmd:fcels]]''       | Issue Fibre Channel ELS request                                  |
^                                                                                            ||
^ Configuration setting commands                                                             ||
^ ''[[:cmd:config]]''      | Start interactive configuration tool                             |
^ ''[[:cmd:show]]''        | Display configuration setting                                    |
^ ''[[:cmd:set]]''         | Set configuration setting                                        |
^ ''[[:cmd:clear]]''       | Delete configuration setting                                     |
^ ''[[:cmd:read]]''        | Prompt user to enter configuration setting                       |
^ ''[[:cmd:inc]]''         | Increment numeric value of configuration setting                 |
^ ''[[:cmd:login]]''       | Prompt user to enter user name and password                      |
^                                                                                            ||
^ Flow control commands                                                                      ||
^ ''[[:cmd:isset]]''       | Test for existence                                               |
^ ''[[:cmd:iseq]]''        | Test for equality                                                |
^ ''[[:cmd:goto]]''        | Jump to script label                                             |
^ ''[[:cmd:exit]]''        | Exit current shell or script                                     |
^                                                                                            ||
^ User interface commands                                                                     |
^ ''[[:cmd:menu]]''        | Create menu                                                      |
^ ''[[:cmd:form]]''        | Create interactive form                                          |
^ ''[[:cmd:item]]''        | Add menu item or form item                                       |
^ ''[[:cmd:choose]]''      | Choose from a menu                                               |
^ ''[[:cmd:present]]''     | Display interactive form                                         |
^                                                                                            ||
^ Certificate management commands                                                            ||
^ ''[[:cmd:certstat]]''    | Display certificates                                             |
^ ''[[:cmd:certstore]]''   | Manage certificates                                              |
^ ''[[:cmd:certfree]]''    | Discard certificates                                             |
^                                                                                            ||
^ Console management commands                                                                ||
^ ''[[:cmd:console]]''     | Configure console                                                |
^ ''[[:cmd:colour]]''      | Define colour                                                    |
^ ''[[:cmd:cpair]]''       | Define colour pair                                               |
^                                                                                            ||
^ Request parameter commands                                                               ||
^ ''[[:cmd:params]]''      | Create request parameter list                                    |
^ ''[[:cmd:param]]''       | Add request parameter                                            |
^                                                                                            ||
^ Miscellaneous commands                                                                     ||
^ ''[[:cmd:echo]]''        | Print text to console                                            |
^ ''[[:cmd:prompt]]''      | Prompt user to press key                                         |
^ ''[[:cmd:shell]]''       | Start new interactive shell                                      |
^ ''[[:cmd:help]]''        | Display list of available commands                               |
^ ''[[:cmd:sleep]]''       | Delay for fixed period of time                                   |
^ ''[[:cmd:reboot]]''      | Reboot system                                                    |
^ ''[[:cmd:poweroff]]''    | Power off system                                                 |
^ ''[[:cmd:cpuid]]''       | Check x86 CPU feature                                            |
^ ''[[:cmd:sync]]''        | Wait for background operations to complete                       |
^ ''[[:cmd:nslookup]]''    | Resolve host name to network address                             |
^ ''[[:cmd:ping]]''        | Check network connectivity                                       |
^ ''[[:cmd:ntp]]''         | Get time and date via NTP                                        |
^ ''[[:cmd:pciscan]]''     | Scan for PCI devices                                             |
^ ''[[:cmd:usbscan]]''     | Scan for USB devices                                             |
^                                                                                            ||
^ Obscure commands                                                                           ||
^ ''[[:cmd:lotest]]''      | Perform loopback testing                                         |
^ ''[[:cmd:pxebs]]''       | Perform PXE boot server discovery                                |
^ ''[[:cmd:time]]''        | Measure time taken to execute command                            |
^ ''[[:cmd:gdbstub]]''     | Start remote debugging                                           |
^ ''[[:cmd:profstat]]''    | Display profiling statistics                                     |