✎ commandline - Etherboot/gPXE Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
=====Etherboot command-line=====
====Network Interfaces====
Etherboot names interfaces following the pattern "net#".

**ifstat [interfaces...]** Displays information and statistics about the specified interface.  If no interface is specified, displays information about all detected interfaces.  Information includes MAC address, PCI bus/slot/function identiers, and packet counts.

**ifopen [interfaces...]** Opens the specified interfaces.  If no interface is specified, opens all interfaces.

**ifclose [interfaces...]** Closes the specified interfaces.  If no interface is specified, closes all interfaces.

**dhcp <interface>**  Attempts to configure the specified network interface using DHCP.  Also opens the interface.

====Working with images====
**imgfetch [-n|--name <image name>] <filename> [arguments...]** Retrieves an image file, giving it a specified name, and prepares it to be executed with the specified arguments.  File name may be a simple path, or an HTTP URL.  Simple paths are assumed to be located on the TFTP server specified by dhcp or **config**.  If //image name// is not specified, the base filename will be used as the name.

**module [-n|--name <image name>] <filename> [arguments...]** Equivalent to **imgfetch**

**initrd [-n|--name <image name>] <filename> [arguments]** Equivalent to **imgfetch**

**imgargs <image name>**  Set or change the arguments for the specified image name.

**imgload <image name>** Prepares an executable image to be booted.

**imgexec [image name]** Execute the loaded image, or a specified image.  If more than one image is loaded, the image must be specified. **Note**, if the specified image is not the most recently loaded one, Bad Things will almost certainly happen.  This should only be done in special cases.

**boot [image name]** Equivalent to **imgexec**

**imgfree** Remove all fetched/loaded images.

**kernel [-n|--name <image name>] <filename> [arguments]** Fetch and load a bzImage format Linux kernel.  Equivalent to an imgfetch followed by imgload.

====Runtime configuration====
**config [scope]**  Enter a GUI to set up runtime configuration.  On some systems (cards) this may be stored in NVRAM.  //Scope// allows the GUI to override or view specific subsets of options.  (see below)

**set <identifier> <value>** Set the value of //identifier// to //value//.  

**show <identifier>** Display the value of //identifier//

**clear <identifier>**  Clear the value of //identifier//
===Identifiers===
All identifiers are set within a scope.
  * **root** (scope unspecified)
  * **proxydhcp** Settings from a Proxy DHCP server (Needs more description)
  * **[interface]** e.g. //net0//.  Settings for a network device.
  * **[interface].dhcp**.  Settings from the DHCP server acquired by //interface//.  Read/write, but note that you cannot specify new options that were not already provided.
  * **[interface].nvo**.  Read/write settings in NVRAM on certain supported cards.  **//WARNING//** this permanently modifies settings on your network card.  It is possible to **damage** your network card by changing settings in this context.  Use at your own risk.
  * **smbios**.  Read-only access to settings in the System Management BIOS (see below)
Identifiers follow the format [scope/]identifier:[type].  For example, to set the IP address of the 'net0' card use //set net0/ip XXX.XXX.XXX.XXX//

Options not specified in a higher scope will be read from a lower one.  So if the option //ip// is unspecified, it will be read from //net0/ip//; if the option //net0/ip// is unspecified, it will be read from //net0.dhcp//.

==Root==
**hostname** The system's hostname.  Sent to the DHCP server for dynamic DNS changes, or specified by the DHCP server.  Equivalent to DHCP option 12 (host name)

**filename** The boot image to be loaded.  Equivalent to DHCP option 67 (Bootfile name)

**root-path** NFS/iSCSI root path.  The path to a network root filesystem.  Equivalent to DHCP option 17 (Root Path)

**username** Username to be used for any authentication.  Currently only used by iSCSI.

**password** Password to be used for any authentication.  Currently only used by iSCSI.  Intended to be stored in card NVRAM, but see warning above.

**priority**
==Network device==
**ip** The device's IPv4 address

**netmask** The device's IPv4 subnet mask

**gateway** The device's default gateway

**mac** The device's MAC address

**dhcp-server** The dhcp server from which settings were obtained

**dns-server** The DNS server to use for resolving hostnames

**next-server** The (TFTP) server from which to obtain files when not specifying an HTTP URL

**initiator_iqn_setting** The iSCSI initiator name
==SMBIOS==
Read-only access to the system's Systems Management BIOS.  Identifiers follow the format <type>.<offset>.<length>:<format>.  Example: To read the Manufacturer name, //get smbios/1.4.0:string// will read SMBIOS offset 4 as a string.  Valid formats: string, ipv4, int8, int16, int32, uint8, uint16, uint32, hex, uuid

**uuid** The system's UUID

====Other====
**autoboot** Attempts to boot the system, as follows:
  * Wait for a link on ethernet
  * Configure via DHCP
  * Boot an embedded image (?)
  * download (and exec) the DHCP-specified boot filename
  * boot from the DHCP-specified root path, using iSCSI or ATA-over-Ethernet.

**exit** Exits gPXE, and passes boot control back to the BIOS.

**sanboot** Attempts to boot the system from a SAN device.

====Outstanding questions====
  * What does autoboot do?  Does it simply execute a script, pre-defined at compile time?  Does it follow its own sequence of boot operations?
  * When multiple images of the same name are fetched, which one will takes precedence?
Trace: • sanboot • week11 • week6 • mdeck • bin2intelhexc • appnotes • staging • week1 • ubuntubko • week4 • wrapup • journal • commandline • initramfsbko • start • 2009 • winbootibft • project_plan