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 .\"
  27 .Dd October 6, 2010
  28 .Dt PXEBOOT 8
  29 .Os
  30 .Sh NAME
  31 .Nm pxeboot
  32 .Nd Preboot Execution Environment (PXE) bootloader
  33 .Sh DESCRIPTION
  34 The
  35 .Nm
  36 bootloader is a modified version of the system third-stage bootstrap
  37 .Xr loader 8
  38 configured to run under Intel's Preboot Execution Environment (PXE) system.
  39 PXE is a form of smart boot ROM, built into Intel EtherExpress Pro/100 and
  40 3Com 3c905c Ethernet cards, and Ethernet-equipped Intel motherboards.
  41 PXE supports DHCP configuration and provides low-level NIC access services.
  42 The
  43 .Nm
  44 bootloader retrieves the kernel, modules,
  45 and other files either via NFS over UDP.
  46 In combination with a NFS-mounted root file system,
  47 .Nm
  48 allows for easy,
  49 EEPROM-burner free construction of diskless machines.
  50 .Pp
  51 The
  52 .Nm
  53 binary is loaded just like any other boot file,
  54 by specifying it in the DHCP server's configuration file.
  55 Below is a sample configuration for the ISC DHCP v2 server:
  56 .Bd -literal -offset indent
  57 option domain-name "example.com";
  58 option routers 10.0.0.1;
  59 option subnet-mask 255.255.255.0;
  60 option broadcast-address 10.0.0.255;
  61 option domain-name-servers 10.0.0.1;
  62 server-name "DHCPserver";
  63 server-identifier 10.0.0.1;
  64
  65 default-lease-time 120;
  66 max-lease-time 120;
  67
  68 subnet 10.0.0.0 netmask 255.255.255.0 {
  69        filename "boot/pxeboot";
  70        range 10.0.0.10 10.0.0.254;
  71        option root-path "10.0.0.1:/netbootroot";
  72 }
  73
  74 .Ed
  75 .Nm
  76 defaults to a conservative 1024 byte NFS data packet.  This may be changed
  77 by setting the
  78 .Va nfs.read_size
  79 variable in
  80 .Pa /boot/loader.conf
  81 ..
  82 Valid values range from 1024 to 4096 bytes.
  83 .Pp
  84 .Nm
  85 recognizes
  86 .Va next-server
  87 and
  88 .Va option root-path
  89 directives as the server and path to NFS mount for file requests,
  90 respectively, or the server to make TFTP requests to.
  91 Note that
  92 .Nm
  93 expects to fetch
  94 .Pa /boot/dloader.rc
  95 from the specified server before loading any other files.
  96 .Pp
  97 .Nm
  98 uses
  99 .Pa /boot/kernel.BOOTP
 100 and
 101 .Pa /boot/loader-bootp.conf
 102 and
 103 .Pa nextboot-bootp.conf
 104 instead of
 105 .Pa /boot/kernel
 106 and
 107 .Pa /boot/loader.conf .
 108 Note that the TFTP version
 109 .Xr pxeboot_tftp 8
 110 uses the standard boot loader files.
 111 The NFS version uses different files to allow BOOTP boots via NFS to
 112 be overloaded onto the same directory structure as a normal boot,
 113 though many other changes would have to be made to actually make
 114 that work.
 115 However, this is more for historical reasons.
 116 Current day PXE boot code can handle complex root-path specifications
 117 allowing the root image to be contained in a sub-directory of the NFS
 118 export.
 119 .Pp
 120 In all other respects,
 121 .Nm
 122 acts just like
 123 .Xr loader 8 .
 124 .Pp
 125 As PXE is still in its infancy, some firmware versions may not work
 126 properly.
 127 The
 128 .Nm
 129 bootloader has been extensively tested on version 0.99 of Intel firmware;
 130 pre-release versions of the newer 2.0 firmware are known to have
 131 problems.
 132 Check with the device's manufacturer for their latest stable release.
 133 .Pp
 134 For further information on Intel's PXE specifications and Wired for
 135 Management (WfM) systems, see
 136 .Pa http://developer.intel.com/ial/wfm/ .
 137 .Sh FILES
 138 .Bl -tag -width ".Pa /boot/defaults/loader-bootp.conf" -compact
 139 .It Pa /boot/kernel.BOOTP
 140 Default kernel for
 141 .Nm .
 142 .It Pa /boot/defaults/loader-bootp.conf
 143 .Nm
 144 configuration file -- do not change this file.
 145 .It Pa /boot/loader-bootp.conf
 146 .Nm
 147 configuration file.
 148 .El
 149 .Sh SEE ALSO
 150 .Xr dhcpd 8 Pq Pa net/isc-dhcp42-server ,
 151 .Xr diskless 8 ,
 152 .Xr loader 8 ,
 153 .Xr nfsd 8 ,
 154 .Xr pxeboot_tftp 8 ,
 155 .Xr tftpd 8
 156 .Sh HISTORY
 157 The
 158 .Nm
 159 bootloader first appeared in
 160 .Fx 4.1 .
 161 .Sh AUTHORS
 162 .An -nosplit
 163 The
 164 .Nm
 165 bootloader was written by
 166 .An John Baldwin Aq Mt jhb@FreeBSD.org
 167 and
 168 .An Paul Saab Aq Mt ps@FreeBSD.org .
 169 This manual page was written by
 170 .An Doug White Aq Mt dwhite@FreeBSD.org .