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_TFTP 8
29.Os
30.Sh NAME
31.Nm pxeboot_tftp
32.Nd Preboot Execution Environment (PXE) bootloader using TFTP
33.Sh DESCRIPTION
34The
35.Nm
36bootloader is a modified version of the system third-stage bootstrap
37.Xr loader 8
38configured to run under Intel's Preboot Execution Environment (PXE) system.
39PXE is a form of smart boot ROM, built into Intel EtherExpress Pro/100 and
403Com 3c905c Ethernet cards, and Ethernet-equipped Intel motherboards.
41PXE supports DHCP configuration and provides low-level NIC access services.
42The
43.Nm
44bootloader retrieves the kernel, modules, and other files via TFTP.
45In combination with a NFS-mounted root file system,
46.Nm
47allows for easy,
48EEPROM-burner free construction of diskless machines.
49.Pp
50The
51.Nm
52binary is loaded just like any other boot file,
53by specifying it in the DHCP server's configuration file.
54Below is a sample configuration for the ISC DHCP v2 server:
55.Bd -literal -offset indent
56option domain-name "example.com";
57option routers 10.0.0.1;
58option subnet-mask 255.255.255.0;
59option broadcast-address 10.0.0.255;
60option domain-name-servers 10.0.0.1;
61server-name "DHCPserver";
62server-identifier 10.0.0.1;
63
64default-lease-time 120;
65max-lease-time 120;
66
67subnet 10.0.0.0 netmask 255.255.255.0 {
68       filename "boot/pxeboot_tftp";
69       range 10.0.0.10 10.0.0.254;
70       option root-path "10.0.0.1:/netbootroot";
71}
72
73.Ed
74.Nm
75recognizes
76.Va next-server
77and
78.Va option root-path
79directives as the server and path to NFS mount for file requests,
80respectively, or the server to make TFTP requests to.
81Note that
82.Nm
83expects to fetch
84.Pa /boot/dloader.rc
85from the specified server before loading any other files.
86.Pp
87In all other respects,
88.Nm
89acts just like
90.Xr loader 8 .
91.Pp
92As PXE is still in its infancy, some firmware versions may not work
93properly.
94The
95.Nm
96bootloader has been extensively tested on version 0.99 of Intel firmware;
97pre-release versions of the newer 2.0 firmware are known to have
98problems.
99Check with the device's manufacturer for their latest stable release.
100.Pp
101For further information on Intel's PXE specifications and Wired for
102Management (WfM) systems, see
103.Pa http://developer.intel.com/ial/wfm/ .
104.Sh SEE ALSO
105.Xr dhcpd 8 Pq Pa net/isc-dhcp42-server ,
106.Xr diskless 8 ,
107.Xr loader 8 ,
108.Xr nfsd 8 ,
109.Xr pxeboot 8 ,
110.Xr tftpd 8
111.Sh HISTORY
112The
113.Nm
114bootloader first appeared in
115.Fx 4.1 .
116.Sh AUTHORS
117.An -nosplit
118The
119.Nm
120bootloader was written by
121.An John Baldwin Aq Mt jhb@FreeBSD.org
122and
123.An Paul Saab Aq Mt ps@FreeBSD.org .
124This manual page was written by
125.An Doug White Aq Mt dwhite@FreeBSD.org .
126