usr/src/man/man5/pxeboot.5

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