iPXE - open source boot firmware cmd

cmd:autoboot

Anonymous (anonymous@undisclosed.example.com) — 2011-03-23T19:29:59+0000

Boot system from network interface Synopsis autoboot [] [...] Examples Boot from the first available network interface autoboot Boot from network interface "net0" autoboot net0 Retry booting indefinitely until it succeeds

cmd:boot

Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T20:11:23+0000

cmd:certfree

Anonymous (anonymous@undisclosed.example.com) — 2016-08-31T18:44:23+0000

Discard certificates Synopsis certfree [--subject ] Examples Discard all non-permanent certificates certfree Discard any certificates matching the subject "forum.ipxe.org" certfree --subject forum.ipxe.org Description Discard the specified certificates from the certificate store. If no subject name is specified, iPXE will discard all stored certificates.

cmd:certstat

Anonymous (anonymous@undisclosed.example.com) — 2016-08-31T16:47:37+0000

Display certificates Synopsis certstat [--subject ] Examples Display all certificates certstat Display certificates matching the subject "forum.ipxe.org" certstat --subject forum.ipxe.org Description Display details of the specified certificates in the certificate store. If no subject name is specified, iPXE will display details of all stored certificates.

cmd:certstore

Anonymous (anonymous@undisclosed.example.com) — 2016-08-31T18:39:31+0000

Manage certificates Synopsis certstore [--subject ] [--keep] [] Examples Download a certificate to the certificate store certstore http://ca.ipxe.org/ca.crt Download a certificate chain to the certificate store certstore http://ca.ipxe.org/cross/cross-digicert-global-root-ca.crts

cmd:chain

Anonymous (anonymous@undisclosed.example.com) — 2021-02-15T16:46:15+0000

Download and boot an executable image Synopsis chain [--name ] [--timeout ] [--autofree] [--replace] [] [...] or imgexec [--name ] [--timeout ] [--autofree] [--replace] [] [...]

cmd:choose

Anonymous (anonymous@undisclosed.example.com) — 2025-02-19T13:28:20+0000

Choose menu item Synopsis choose [--menu ] [--default ] [--keep] [--timeout ] [--retimeout ] Examples Create and display a simple menu menu Please choose an operating system to boot item fedora Fedora Linux item win7 Windows 7 choose os

cmd:clear

Anonymous (anonymous@undisclosed.example.com) — 2013-08-02T11:15:04+0000

Delete configuration setting Synopsis clear Examples Clear any statically-assigned IP address for "net0" clear net0/ip clear net0/netmask clear net0/gateway Description Delete the specified configuration setting. Command status Success

cmd:colour

Anonymous (anonymous@undisclosed.example.com) — 2014-01-23T02:20:06+0000

Define colour Synopsis colour [--basic ] [--rgb ] Examples Redefine colour 7 as ANSI red colour --basic 1 7 Redefine colour 7 as ANSI red and use it as the default foreground colour colour --basic 1 7 cpair --foreground 7 0

cmd:config

Anonymous (anonymous@undisclosed.example.com) — 2011-03-27T12:31:10+0000

Start interactive configuration tool Synopsis config [] Examples Start the interactive configuration tool config Start the tool to configure the interface "net0" config net0 Description Start the interactive configuration tool to edit configuration

cmd:console

Anonymous (anonymous@undisclosed.example.com) — 2021-02-18T01:26:34+0000

Configure graphical console Synopsis console [--x ] [--y ] [--left ] [--right ] [--top ] [--bottom ] [--depth ] [--picture ] [--keep]

cmd:cpair

Anonymous (anonymous@undisclosed.example.com) — 2014-01-23T02:26:42+0000

Define colour pair Synopsis cpair [--foreground ] [--background ] Examples Redefine the default colour pair as yellow on cyan cpair --foreground 3 --background 6 0 Redefine the default colour pair using 24-bit RGB colours

cmd:cpuid

Anonymous (anonymous@undisclosed.example.com) — 2025-02-10T14:38:43+0000

Check x86 CPU feature Synopsis cpuid [--ext] [--ecx] Examples Check if CPU supports 64-bit operation ("long mode") cpuid --ext 29 && set arch x86_64 || set arch i386 Check if CPU supports physical address extensions ("PAE") cpuid 6 && set pae yes ||

cmd:dhcp

Anonymous (anonymous@undisclosed.example.com) — 2014-01-29T14:19:27+0000

cmd:digest

Anonymous (anonymous@undisclosed.example.com) — 2025-08-06T13:43:49+0000

Calculate checksum of an image Synopsis md5sum [--set ] ... sha1sum [--set ] ... sha256sum [--set ] ... sha512sum [--set ] ... (etc.) Examples Download an image and show its SHA-256 checksum

cmd:echo

Anonymous (anonymous@undisclosed.example.com) — 2011-03-27T11:53:56+0000

Print text to console Synopsis echo [-n] [...] Examples Print "hello world" echo hello world Print the boot filename echo ${filename} Print the MAC address of interface "net0" echo MAC address is ${net0/mac} Ask the user to supply a filename

cmd:exit

Anonymous (anonymous@undisclosed.example.com) — 2011-03-23T19:30:37+0000

Exit current shell or script Synopsis exit [] Examples Exit the shell exit Exit the current script successfully exit 0 Exit the current script with an error exit 1 Description Exit the iPXE shell, or the currently running script. If a status is explicitly specified, then this status will be returned to the caller of the script.

cmd:fcels

Anonymous (anonymous@undisclosed.example.com) — 2011-10-26T15:01:49+0000

Issue Fibre Channel ELS request Synopsis fcels [--port ] [--id ] Examples Log in to the peer 18.ae.01 fcels --id 18.ae.01 plogi Ping the peer 18.ae.01 fcels --id 18.ae.01 echo Log out from the fabric fcels logo

cmd:fcstat

Anonymous (anonymous@undisclosed.example.com) — 2011-10-26T15:01:32+0000

Display Fibre Channel ports Synopsis fcstat Examples Display all Fibre Channel ports fcstat Description Display the state of all Fibre Channel ports. The output will show key information about each Fibre Channel port. For example: iPXE> fcstat net0: 20:00:52:54:00:12:34:56 id 18.ae.02 node 10:00:52:54:00:12:34:56 [Link: up, 20:00:ae:a5:83:a2:78:1a fabric node 10:00:ae:a5:83:a2:78:1a] 20:00:ae:a5:83:a2:78:1a: [Link: up, port net0 id ff.ff.fc] 20:00:00:1f:16:bc:fe:2f: …

cmd:fdt

Anonymous (anonymous@undisclosed.example.com) — 2025-03-28T15:52:41+0000

Configure Flattened Device Tree Synopsis fdt [--timeout ] Examples Boot a kernel with an initrd and device tree blob #!ipxe kernel /images/vmlinuz console=ttyAMA0 initrd /images/initrd.img fdt /images/rk3566-radxa-zero-3e.dtb boot

cmd:form

Anonymous (anonymous@undisclosed.example.com) — 2024-06-21T17:35:38+0000

Create interactive form Synopsis form [--name ] [--delete] [] Examples Configure IPv4 networking form Configure IPv4 networking on ${netX/mac} item netX/ip IPv4 address item netX/netmask Subnet mask item netX/gateway Gateway address item dns DNS server address present </article> <article> <h1>cmd:gdbstub</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-21T22:15:52+0000</p> Start remote debugging Synopsis gdbstub <transport> [<options>...] Examples Start remote debugging via serial port gdbstub serial Start remote debugging via net1 gdbstub udp net1 Description Start remote debugging via the specified transport. Supported transports are: </article> <article> <h1>cmd:goto</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2013-08-01T14:21:32+0000</p> Jump to script label Synopsis goto <label> Examples Print "hello world" indefinitely :loop echo Hello world goto loop Jump to a calculated label goto host_${hostname} || goto unknown Description Jump to a script label. This command can be used only within an iPXE </article> <article> <h1>cmd:help</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-03-23T19:27:37+0000</p> Display list of available commands Synopsis help Examples Display list of available commands help Description Display list of available commands. For example: iPXE> help Available commands: echo exit isset goto help shell autoboot config dhcp pxebs ifopen ifclose ifstat imgfetch module initrd kernel cha… </article> <article> <h1>cmd:ifclose</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T19:03:03+0000</p> Close interfaces Synopsis ifclose [<interface>] [<interface>...] Examples Close all interfaces ifclose Close the interface "net0" ifclose net0 Description Close the specified network interfaces. If no network interfaces are explicitly specified, iPXE will close all available network interfaces. </article> <article> <h1>cmd:ifconf</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2021-01-26T17:34:29+0000</p> Automatically configure interfaces Synopsis ifconf [--configurator <configurator>] [--timeout <timeout>] [<interface>...] Examples Automatically configure the first available interface ifconf Automatically configure the interface "net0" ifconf net0 </article> <article> <h1>cmd:iflinkwait</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2021-01-26T17:31:00+0000</p> Wait for link-up Synopsis iflinkwait [--timeout <timeout>] [<interface>] [<interface>...] Examples Wait indefinitely for link-up on "net0" iflinkwait net0 Find the first interface with a usable link iflinkwait --timeout 5000 Description Wait for link-up on a network interface. iPXE will open the first specified network interface and wait for a link to be detected. If a usable link is detected, the command will terminate and the network interface will be left open. If no link is de… </article> <article> <h1>cmd:ifopen</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T19:03:25+0000</p> Open interfaces Synopsis ifopen [<interface>] [<interface>...] Examples Open the interface "net0" ifopen net0 Description Open the specified network interfaces. If no network interfaces are explicitly specified, iPXE will open all available network interfaces. </article> <article> <h1>cmd:ifstat</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2021-01-26T21:09:56+0000</p> Display interfaces Synopsis ifstat [<interface>] [<interface>...] Examples Display all interfaces ifstat Display the interface "net0" ifstat net0 Description Display the state of the specified network interfaces. If no network interfaces are explicitly specified, iPXE will display the state of all available network interfaces. </article> <article> <h1>cmd:imgargs</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T20:56:11+0000</p> Set image command-line arguments Synopsis imgargs [--name <name>] <uri|image> [<arguments>...] Examples Set command-line arguments for a Linux kernel image "vmlinuz" imgargs vmlinuz vga=788 console=ttyS0,115200n8 console=tty0 Description Set command-line arguments to be passed to the specified image. </article> <article> <h1>cmd:imgdecrypt</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2024-08-29T14:42:00+0000</p> Decrypt an encrypted image Synopsis imgdecrypt [--name <name>] [--timeout <timeout>] [--keep] <uri|image> <envelope uri|image> Examples Decrypt and boot an encrypted Linux kernel imgdecrypt http://192.168.0.1/vmlinuz.dat http://129.168.0.1/vmlinuz.env boot vmlinuz </article> <article> <h1>cmd:imgexec</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T20:11:42+0000</p> </article> <article> <h1>cmd:imgextract</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2021-05-12T14:12:25+0000</p> Extract a compressed or archive image Synopsis imgextract [--name <name>] [--timeout <timeout>] [--keep] <uri|image> Examples Download and extract a gzip-compressed initrd image imgextract http://192.168.0.1/images/initrd.gz Description Extract a single image from an archive image (which may be a compressed single-file archive). </article> <article> <h1>cmd:imgfetch</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-02-24T14:55:25+0000</p> Download an image Synopsis imgfetch [--name <name>] [--timeout <timeout>] <uri> [<arguments>...] or module [--name <name>] [--timeout <timeout>] <uri> [<arguments>...] or initrd [--name <name>] [--timeout <timeout>] <uri> [<arguments>...] Examples </article> <article> <h1>cmd:imgfree</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T19:02:09+0000</p> Discard images Synopsis imgfree [<image>] Examples Discard all images imgfree Discard the image "pxelinux.0" imgfree pxelinux.0 Description Discard the specified image. If no image is explicitly specified, iPXE will discard all images. The memory used to hold the image will be released and made available for reuse. </article> <article> <h1>cmd:imgload</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T20:58:10+0000</p> </article> <article> <h1>cmd:imgselect</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T20:57:53+0000</p> </article> <article> <h1>cmd:imgstat</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T20:22:31+0000</p> Display images Synopsis imgstat [<name>...] Examples Display all images imgstat Display the image ''pxelinux.0'' imgstat pxelinux.0 Description Display information about the specified images. If no images are explicitly specified, iPXE will display information about all images. For example: </article> <article> <h1>cmd:imgtrust</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T20:32:07+0000</p> Set image trust requirement Synopsis imgtrust [--allow] [--permanent] Examples Require trusted images imgtrust Allow untrusted images imgtrust --allow Permanently require trusted images imgtrust --permanent Description Require the use of trusted images. When trusted images are required, any attempts to execute an untrusted image will fail. All images are untrusted by default. To become trusted, an image must be verified using the </article> <article> <h1>cmd:imgverify</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2024-08-29T14:38:01+0000</p> Verify an image as trusted Synopsis imgverify [--signer <signer>] [--keep] <uri|image> <signature uri|image> Examples Verify the signature on an iPXE script imgverify script.ipxe script.ipxe.sig Verify the signature on a Linux kernel kernel http://192.168.0.1/vmlinuz vga=788 splash=silent imgverify vmlinuz http://192.168.0.1/vmlinuz.sig </article> <article> <h1>cmd:inc</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2013-08-01T14:50:38+0000</p> Increment numeric value of configuration setting Synopsis inc <setting> [<increment>] Examples Increment a numeric value iPXE> set x:int32 5 iPXE> inc x iPXE> show x x:int32 = 6 Iterate over all network devices #!ipxe set idx:int32 0 :loop isset ${net${idx}/mac} || goto loop_done echo net${idx} is a ${net${idx}/chip} with MAC ${net${idx}/mac} inc idx && goto loop :loop_done </article> <article> <h1>cmd:initrd</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-03-07T01:36:09+0000</p> </article> <article> <h1>cmd:ipstat</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2014-03-03T13:57:08+0000</p> Display IP statistics Synopsis ipstat Examples Display IP statistics ipstat Description Display IP statistics. The output will show various counters. For example: iPXE> ipstat IP version 4: InReceives:133 InMcastPkts:0 InBcastPkts:120 InOctets:32613 InHdrErrors:0 InAddrErrors:0 InUnknownProtos:0 InTruncatedPkts:0 ReasmReqds:0 ReasmOKs:0 ReasmFails:0 InDelivers:133 OutRequests:16 OutNoRoutes:5 OutTransmits:11 OutMcastPkts:0 OutBcastPkts:2 OutOctets:1544 </article> <article> <h1>cmd:iseq</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-04-08T18:53:52+0000</p> Test for equality Synopsis iseq <value1> <value2> Examples Prompt user to confirm IP configuration echo IP configuration: route echo -n Is this correct? (y/n) ${} && read answer iseq ${answer} Y && goto is_correct || iseq ${answer} y && goto is_correct || goto retry </article> <article> <h1>cmd:isset</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-04-08T18:49:34+0000</p> Test for existence Synopsis isset <value> Examples Boot if a filename is specified isset ${filename} && chain ${filename} || goto no_filename Set a default DNS server if none is specified isset ${dns} || set dns 192.168.0.1 Retry DHCP indefinitely until a filename is obtained </article> <article> <h1>cmd:item</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2026-02-26T12:53:56+0000</p> Add menu item or form item Synopsis item [--menu <menu>] [--key <key>] [--default] [<name>|--gap [<text>]] item [--form <form>] [--key <key>] [--default] [--secret] [<name>|--gap [<text>]] Examples Create and display a simple menu menu Please choose an operating system to boot item fedora Fedora Linux item win7 Windows 7 choose os </article> <article> <h1>cmd:kernel</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2023-05-24T12:59:33+0000</p> Download and select an executable image Synopsis kernel [--name <name>] [--timeout <timeout>] <uri|image> [<arguments>...] or imgselect [--name <name>] [--timeout <timeout>] <uri|image> [<arguments>...] or imgload [--name <name>] [--timeout <timeout>] <uri|image> [<arguments>...] </article> <article> <h1>cmd:login</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2024-06-21T17:31:02+0000</p> Prompt user to enter user name and password Synopsis login Examples Prompt user to enter user name and password login echo Hello ${username} Boot from iSCSI target using CHAP authentication login sanboot iscsi:10.0.4.1:::1:iqn.2010-04.org.ipxe.dolphin:storage </article> <article> <h1>cmd:lotest</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2016-05-23T22:38:26+0000</p> Perform loopback testing Synopsis lotest [--mtu <mtu>] [--broadcast] <sending interface> <receiving interface> Examples Perform a loopback test from "net0" to "net1" lotest net0 net1 Description Perform a loopback test by sending packets from one network interface and verifying that they are received correctly on a second network interface. The two network interfaces should be directly connected using a network cable. </article> <article> <h1>cmd:md4sum</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-08-06T14:35:14+0000</p> </article> <article> <h1>cmd:md5sum</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-08-06T14:34:32+0000</p> </article> <article> <h1>cmd:menu</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-28T23:41:46+0000</p> Create menu Synopsis menu [--name <name>] [--delete] [<title>] Examples Create and display a simple menu menu Please choose an operating system to boot item fedora Fedora Linux item win7 Windows 7 choose os Create a named menu menu --name iscsi Select iSCSI target </article> <article> <h1>cmd:module</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-03-07T01:35:34+0000</p> </article> <article> <h1>cmd:nslookup</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-09-10T21:55:02+0000</p> Resolve host name to network address Synopsis nslookup <setting> <hostname> Examples Look up the IP address for ipxe.org nslookup address ipxe.org echo ${address} Set TFTP next-server address to boot.ipxe.org nslookup net0/next-server boot.ipxe.org </article> <article> <h1>cmd:nstat</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2014-03-03T13:40:37+0000</p> Display neighbour table Synopsis nstat Examples Display neighbour table nstat Description Display all entries in the neighbour table. The output will show key information about each neighbour. For example: iPXE> nstat net0 IP 10.253.253.1 is Ethernet 02:00:69:50:58:45 (ARP) net0 IP 10.253.253.22 is Ethernet (incomplete) (ARP) net0 IPv6 fe80::69ff:fe50:5845 is Ethernet 02:00:69:50:58:45 net0 IPv6 3ffe:302:11:2:0:69ff:fe50:5845 is Ethernet 02:00:69:50:58:45 net0 IPv6 3ffe:302:… </article> <article> <h1>cmd:ntp</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2017-01-26T12:49:44+0000</p> Get time and date via NTP Synopsis ntp <host> Examples Get time and date from pool.ntp.org ntp pool.ntp.org Description Get the time and date from a Network Time Protocol (NTP) server. This will affect only the time and date as used by iPXE. The underlying hardware clock will not be updated. </article> <article> <h1>cmd:param</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2023-03-01T12:30:10+0000</p> Add request parameter Synopsis param [--params <params>] [--header] <key> <value> Examples Issue an HTTP POST request params param mac ${net0/mac} param uuid ${uuid} param asset ${asset} chain http://boot.ipxe.org/demo/boot.php##params Use a custom HTTP header </article> <article> <h1>cmd:params</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2023-03-01T12:32:55+0000</p> Create request parameter list Synopsis params [--name <name>] [--delete] Examples Create an unnamed request parameter list params Issue an HTTP POST using a request parameter list params param mac ${net0/mac} param uuid ${uuid} param asset ${asset} chain http://boot.ipxe.org/demo/boot.php##params </article> <article> <h1>cmd:pciscan</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2013-08-05T13:44:01+0000</p> Scan for PCI devices Synopsis pciscan <setting> Examples Scan for all PCI devices #!ipxe :scan pciscan addr || goto scan_done echo Found PCI device ${addr:busdevfn} goto scan :scan_done Description Scan the PCI bus, starting from the PCI bus:dev.fn address in the specified setting, and store the PCI bus:dev.fn address of the next device in the specified setting. If the specified setting is empty, then the scan will start from the first PCI device. </article> <article> <h1>cmd:ping</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2017-05-24T16:10:00+0000</p> Check network connectivity Synopsis ping [--size <size>] [--timeout <timeout>] [--count <count>] <host> Examples Check connectivity to www.ipxe.org iPXE> ping www.ipxe.org 64 bytes from 212.13.204.60: seq=1 64 bytes from 212.13.204.60: seq=2 64 bytes from 212.13.204.60: seq=3 </article> <article> <h1>cmd:poweroff</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2013-07-15T11:51:26+0000</p> Power off system Synopsis poweroff Examples Power off the system poweroff Description Power off the system immediately. Build options This command is available only when the build option POWEROFF_CMD is enabled. See also * reboot * exit * List of all iPXE commands Notes This may not work on all systems. </article> <article> <h1>cmd:present</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2024-06-21T18:07:33+0000</p> Display interactive form Synopsis present [--form <menu>] [--keep] Examples Create and display a simple form form Configure IPv4 networking on ${netX/mac} item netX/ip IPv4 address item netX/netmask Subnet mask item netX/gateway Gateway address item dns DNS server address present </article> <article> <h1>cmd:profstat</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2014-04-28T14:04:07+0000</p> Display profiling statistics Synopsis profstat Examples Display profiling statistics profstat Description Display profiling statistics. The output will show the mean, standard deviation, and instance counter for each enabled profiler. For example: </article> <article> <h1>cmd:prompt</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-28T23:32:07+0000</p> Prompt user to press key Synopsis prompt [--key <key>] [--timeout <timeout>] [<text>] Examples Wait for the user to press a key prompt Prompt the user to press a key to continue prompt Press any key to continue Exit script if 'q' is pressed prompt --key q Press 'q' to quit && exit || </article> <article> <h1>cmd:pxebs</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-03-04T12:09:12+0000</p> Perform PXE boot server discovery Synopsis pxebs <interface> <server type> Examples Discover boot servers of type 3 on interface "net0" pxebs net0 3 Description Perform PXE boot server discovery for the specified server type on the specified network interface. </article> <article> <h1>cmd:read</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2024-06-21T17:16:07+0000</p> Prompt user to enter configuration setting Synopsis read [--timeout <timeout>] <setting> Examples Prompt user to enter boot filename read filename Allow user to configure an IP address for the interface "net0" echo -n IP address: && read net0/ip echo -n Subnet mask: && read net0/netmask echo -n Default gateway: && read net0/gateway </article> <article> <h1>cmd:reboot</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-04-28T13:12:06+0000</p> Reboot system Synopsis reboot [--warm] [--setup] Examples Reboot the system reboot Description Reboot the system immediately. If the --warm option is specified then a warm reboot will be performed, otherwise a cold reboot will be performed. </article> <article> <h1>cmd:route</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-03-23T19:23:38+0000</p> Display routing table Synopsis route Examples Display the routing table route Acquire an IP address via DHCP and display it dhcp && route Description Display the routing table, including the IP addresses assigned to each network interface. For example, to acquire an IP address via </article> <article> <h1>cmd:sanboot</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2024-03-07T16:58:36+0000</p> Boot from SAN device Synopsis sanboot [--drive <drive>] [--filename <filename>] [--extra <filename>] [--label <label>] [--uuid <uuid>] [--no-describe] [--keep] [<uri>] [<uri>...] Examples Boot from an iSCSI target sanboot iscsi:10.0.4.1:::1:iqn.2010-04.org.ipxe.dolphin:storage </article> <article> <h1>cmd:sanhook</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2017-03-26T13:38:54+0000</p> Attach SAN device Synopsis sanhook [--drive <drive>] [--no-describe] <uri> [<uri>...] Examples Attach an iSCSI target sanhook iscsi:10.0.4.1:::1:iqn.2010-04.org.ipxe.dolphin:storage Attach a multipath iSCSI target sanhook iscsi:192.168.0.101::::iqn.2010-04.org.ipxe.squirrel:storage \ iscsi:192.168.0.102::::iqn.2010-04.org.ipxe.squirrel:storage </article> <article> <h1>cmd:sanunhook</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-04-24T19:46:52+0000</p> Detach SAN device Synopsis sanunhook [--drive <drive>] Examples Detach SAN drive 0x80 sanunhook Check ability to attach a SAN target sanhook ${root-path} && sanunhook || echo Could not attach ${root-path} Description Detach the specified SAN drive. If no SAN drive is explicitly specified then the default SAN drive ( </article> <article> <h1>cmd:set</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2013-08-01T14:19:59+0000</p> Set configuration setting Synopsis set <setting> <value> Examples Configure a static IP address for the interface "net0" set net0/ip 192.168.0.100 set net0/netmask 255.255.255.0 set net0/gateway 192.168.0.1 Configure a DNS server set dns 192.168.0.1 </article> <article> <h1>cmd:sha1sum</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-08-06T14:34:06+0000</p> </article> <article> <h1>cmd:sha224sum</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-08-06T14:35:29+0000</p> </article> <article> <h1>cmd:sha256sum</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-08-06T14:34:21+0000</p> </article> <article> <h1>cmd:sha384sum</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-08-06T14:35:39+0000</p> </article> <article> <h1>cmd:sha512sum</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2025-08-06T14:34:43+0000</p> </article> <article> <h1>cmd:shell</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-03-23T19:31:10+0000</p> Start new interactive shell Synopsis shell Examples Start a new interactive shell shell Allow the user to intervene if DHCP fails dhcp || shell Description Start a new interactive shell, allowing the user to enter commands at the iPXE command line. Command status </article> <article> <h1>cmd:shim</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2026-03-06T14:43:33+0000</p> Configure UEFI shim image Synopsis shim [--timeout <timeout>] [<extra options>] <uri|image> Examples Download and configure a shim (if needed) shim http://192.168.0.1/shimx64.efi Boot the RHEL installer via shim (if needed) #!ipxe set mirror http://192.168.0.1/rhel/BaseOS/x86_64/os kernel ${mirror}/images/pxeboot/vmlinuz initrd=initrd.img inst.repo=${mirror} initrd ${mirror}/images/pxeboot/initrd.img shim ${mirror}/EFI/BOOT/BOOTX64.EFI boot </article> <article> <h1>cmd:show</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-03-27T12:31:37+0000</p> Display configuration setting Synopsis show <setting> Examples Display the IP address for the interface "net0" show net0/ip Display the boot filename show filename Display DHCP option 42 as an IPv4 address show 42:ipv4 # Option 42 - NTP server address </article> <article> <h1>cmd:sleep</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-06-09T18:24:46+0000</p> Delay for fixed period of time Synopsis sleep <seconds> Examples Sleep for 10 seconds sleep 10 Description Do nothing for the specified number of seconds. The sleep may be interrupted by pressing Ctrl-C. Command status Success The sleep completed successfully </article> <article> <h1>cmd:sync</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-06-09T18:28:06+0000</p> Wait for background operations to complete Synopsis sync [--timeout <timeout>] Examples Wait for background operations to complete sync Wait for at most one second for background operations to complete sync --timeout 1000 Description Wait for any background operations to complete. If no timeout is explicitly specified, or if a zero timeout is specified, iPXE will wait indefinitely. </article> <article> <h1>cmd:time</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-10-26T15:17:50+0000</p> Measure time taken to execute command Synopsis time <command> [<arguments>] Examples Measure the time taken to download a 10MB file time imgfetch http://192.168.0.1/10mb Description Measure the time taken to execute the specified command. Any arguments will be passed directly to the specified command. </article> <article> <h1>cmd:usbscan</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2024-10-18T13:16:29+0000</p> Scan for USB devices Synopsis usbscan <setting> Examples Scan for all USB devices #!ipxe :scan usbscan addr || goto scan_done echo Found USB device ${addr:hex} goto scan :scan_done Description Scan the USB bus, starting from the USB bus:dev address in the specified setting, and store the USB bus:dev address of the next device in the specified setting. If the specified setting is empty, then the scan will start from the first USB device. </article> <article> <h1>cmd:vcreate</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2012-03-24T20:31:48+0000</p> Create VLAN Synopsis vcreate --tag <tag> [--priority <priority>] <trunk interface> Examples Create VLAN 123 on interface "net0" vcreate --tag 123 net0 Boot from VLAN 123 on interface "net0" vcreate --tag 123 net0 autoboot net0-123 Description </article> <article> <h1>cmd:vdestroy</h1> <p>Anonymous (anonymous@undisclosed.example.com) — 2011-10-26T14:43:28+0000</p> Destroy VLAN Synopsis vdestroy <VLAN interface> Examples Destroy VLAN 123 on interface "net0" vdestroy net0-123 Description Destroy a VLAN network interface that was previously created using vcreate. See also * vcreate * List of all iPXE commands Build options This command is available only when the build option </article> </main></body></html>