sys/boot/pc32/pxeldr/pxeboot.8

   1 .\" Copyright (c) 1999 Doug White
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/sys/boot/i386/pxeldr/pxeboot.8,v 1.7 2002/12/12 17:25:59 ru Exp $
  26 .\" $DragonFly: src/sys/boot/pc32/pxeldr/pxeboot.8,v 1.9 2008/08/30 19:02:49 swildner Exp $
  27 .\"
  28 .\" Note: The date here should be updated whenever a non-trivial
  29 .\" change is made to the manual page.
  30 .Dd October 6, 2010
  31 .Dt PXEBOOT 8
  32 .Os
  33 .Sh NAME
  34 .Nm pxeboot
  35 .Nd Preboot Execution Environment (PXE) bootloader
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 bootloader is a modified version of the system third-stage bootstrap
  40 .Xr loader 8
  41 configured to run under Intel's Preboot Execution Environment (PXE) system.
  42 PXE is a form of smart boot ROM, built into Intel EtherExpress Pro/100 and
  43 3Com 3c905c Ethernet cards, and Ethernet-equipped Intel motherboards.
  44 PXE supports DHCP configuration and provides low-level NIC access services.
  45 The
  46 .Nm
  47 bootloader retrieves the kernel, modules,
  48 and other files either via NFS over UDP.
  49 In combination with a NFS-mounted root file system,
  50 .Nm
  51 allows for easy,
  52 EEPROM-burner free construction of diskless machines.
  53 .Pp
  54 The
  55 .Nm
  56 binary is loaded just like any other boot file,
  57 by specifying it in the DHCP server's configuration file.
  58 Below is a sample configuration for the ISC DHCP v2 server:
  59 .Bd -literal -offset indent
  60 option domain-name "example.com";
  61 option routers 10.0.0.1;
  62 option subnet-mask 255.255.255.0;
  63 option broadcast-address 10.0.0.255;
  64 option domain-name-servers 10.0.0.1;
  65 server-name "DHCPserver";
  66 server-identifier 10.0.0.1;
  67
  68 default-lease-time 120;
  69 max-lease-time 120;
  70
  71 subnet 10.0.0.0 netmask 255.255.255.0 {
  72        filename "boot/pxeboot";
  73        range 10.0.0.10 10.0.0.254;
  74        option root-path "10.0.0.1:/netbootroot";
  75 }
  76
  77 .Ed
  78 .Nm
  79 recognizes
  80 .Va next-server
  81 and
  82 .Va option root-path
  83 directives as the server and path to NFS mount for file requests,
  84 respectively, or the server to make TFTP requests to.
  85 Note that
  86 .Nm
  87 expects to fetch
  88 .Pa /boot/dloader.rc
  89 from the specified server before loading any other files.
  90 .Pp
  91 .Nm
  92 uses
  93 .Pa /boot/kernel.BOOTP
  94 and
  95 .Pa /boot/loader-bootp.conf
  96 and
  97 .Pa nextboot-bootp.conf
  98 instead of
  99 .Pa /boot/kernel
 100 and
 101 .Pa /boot/loader.conf .
 102 Note that the TFTP version
 103 .Xr pxeboot_tftp 8
 104 uses the standard boot loader files.
 105 The NFS version uses different files to allow BOOTP boots via NFS to
 106 be overloaded onto the same directory structure as a normal boot,
 107 though many other changes would have to be made to actually make
 108 that work.
 109 However, this is more for historical reasons.
 110 Current day PXE boot code can handle complex root-path specifications
 111 allowing the root image to be contained in a sub-directory of the NFS
 112 export.
 113 .Pp
 114 In all other respects,
 115 .Nm
 116 acts just like
 117 .Xr loader 8 .
 118 .Pp
 119 As PXE is still in its infancy, some firmware versions may not work
 120 properly.
 121 The
 122 .Nm
 123 bootloader has been extensively tested on version 0.99 of Intel firmware;
 124 pre-release versions of the newer 2.0 firmware are known to have
 125 problems.
 126 Check with the device's manufacturer for their latest stable release.
 127 .Pp
 128 For further information on Intel's PXE specifications and Wired for
 129 Management (WfM) systems, see
 130 .Pa http://developer.intel.com/ial/wfm/ .
 131 .Sh FILES
 132 .Bl -tag -width ".Pa /boot/defaults/loader-bootp.conf" -compact
 133 .It Pa /boot/kernel.BOOTP
 134 Default kernel for
 135 .Nm .
 136 .It Pa /boot/defaults/loader-bootp.conf
 137 .Nm
 138 configuration file -- do not change this file.
 139 .It Pa /boot/loader-bootp.conf
 140 .Nm
 141 configuration file.
 142 .El
 143 .Sh SEE ALSO
 144 .Xr dhcpd 8 Pq Pa pkgsrc/net/isc-dhcpd4 ,
 145 .Xr diskless 8 ,
 146 .Xr loader 8 ,
 147 .Xr nfsd 8 ,
 148 .Xr pxeboot_tftp 8 ,
 149 .Xr tftpd 8
 150 .Sh HISTORY
 151 The
 152 .Nm
 153 bootloader first appeared in
 154 .Fx 4.1 .
 155 .Sh AUTHORS
 156 .An -nosplit
 157 The
 158 .Nm
 159 bootloader was written by
 160 .An John Baldwin Aq jhb@FreeBSD.org
 161 and
 162 .An Paul Saab Aq ps@FreeBSD.org .
 163 This manual page was written by
 164 .An Doug White Aq dwhite@FreeBSD.org .