This is an old revision of the document!
=====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 executed. **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 setting up options within a specific context. Known scopes: * **proxydhcp** Settings from a Proxy DHCP server (Needs more description) * **[interface]** e.g. //net0//. Set up a specific network device * **[interface].dhcp**. Over-ride settings from the DHCP server * **[interface].nvo**. Read/write settings in NVRAM on certain supported cards. **//WARNING//** this permanently modifies settings on your network card. As such there is some risk involved. It is possible to **LOSE** data with this, particularly the MAC address. * **smbios**. Read-only access to settings in the System Management BIOS (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=== Where there is correspondence between the gPXE option and a DHCP option, options specified by the DHCP server will be pre-filled. Identifiers follow the format [scope]/identifier. For example, to set the IP address of the 'net0' card use //set net0/ip XXX.XXX.XXX.XXX// **uuid** The system's UUID **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** **ip** The system's IPv4 address **netmask** The system's IPv4 subnet mask **gateway** The system's default gateway **mac** The system'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 ====Other==== **autoboot** Attempts to boot the system **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? * What does the **initrd** command do that's special? It obviously sets the image type to initrd, but what's the effect of that? Is there a way to specify the type of a loaded image after the fact?
