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.Dd May 28, 2017 26.Dt PXEBOOT 5 27.Os 28.Sh NAME 29.Nm pxeboot 30.Nd Preboot Execution Environment (PXE) bootloader 31.Sh DESCRIPTION 32The 33.Nm 34bootloader is a modified version of the system third-stage bootstrap 35.Xr loader 5 36configured to run under Intel's Preboot Execution Environment (PXE) system. 37PXE is a form of smart boot ROM, built into Ethernet cards, and 38Ethernet-equipped motherboards. 39PXE supports DHCP configuration and provides low-level NIC access services. 40.Pp 41The DHCP client will set a DHCP user class named 42.Va illumos 43to allow flexible configuration of the DHCP server. 44.Pp 45The 46.Nm 47bootloader retrieves the kernel, modules, 48and other files either via NFS over UDP or by TFTP, 49selectable through DHCP options. 50.Pp 51The 52.Nm 53binary is loaded just like any other boot file, 54by specifying it in the DHCP server's configuration file. 55Below is a sample configuration for the ISC DHCP v2 server: 56.Bd -literal -offset indent 57option domain-name "example.com"; 58option routers 10.0.0.1; 59option subnet-mask 255.255.255.0; 60option broadcast-address 10.0.0.255; 61option domain-name-servers 10.0.0.1; 62server-name "DHCPserver"; 63server-identifier 10.0.0.1; 64 65default-lease-time 120; 66max-lease-time 120; 67 68subnet 10.0.0.0 netmask 255.255.255.0 { 69 filename "pxeboot"; 70 range 10.0.0.10 10.0.0.254; 71 if exists user-class and option user-class = "illumos" { 72 option root-path "tftp://10.0.0.1/illumos"; 73 } 74} 75 76.Ed 77.Pp 78.Nm 79recognizes 80.Va next-server 81and 82.Va option root-path 83directives as the server and path to NFS mount for file requests, 84respectively, or the server to make TFTP requests to. 85Note that 86.Nm 87expects to fetch 88.Pa /boot/loader.rc 89from the specified server before loading any other files. 90.Pp 91Valid 92.Cm option Va root-path 93syntax is 94.Bd -literal -offset indent 95[<scheme>://][<ip-address>/]<path> 96.Ed 97.Pp 98\&...where 99.Qq scheme 100is either 101.Qq nfs 102or 103.Qq tftp , 104.Qq ip-address 105is the address of the server, and 106.Qq path 107is the path to the root filesystem on the server. 108If 109.Qq scheme 110is not specified, 111.Nm 112defaults to using NFS if the 113.Va root-path 114variable is in the 115.Qq Pa ip-address Ns :/ Ns Pa path 116form, otherwise TFTP is used. 117.Pp 118.Nm 119defaults to a conservative 1024 byte NFS data packet size. 120This may be changed by setting the 121.Va nfs.read_size 122variable in 123.Pa /boot/loader.conf . 124Valid values range from 1024 to 16384 bytes. 125.Pp 126TFTP block size can be controlled by setting the 127.Va tftp.blksize 128variable in 129.Pa /boot/loader.conf . 130Valid values range from 8 to 9008 bytes. 131.Pp 132In all other respects, 133.Nm 134acts just like 135.Xr loader 5 . 136.Pp 137For further information on Intel's PXE specifications and Wired for 138Management (WfM) systems, see 139.Li http://www.intel.com/design/archives/wfm/ . 140.Sh SEE ALSO 141.Xr loader 5 142