summaryrefslogtreecommitdiff
path: root/usr/src/man/man5/pxeboot.5
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man5/pxeboot.5')
-rw-r--r--usr/src/man/man5/pxeboot.5148
1 files changed, 0 insertions, 148 deletions
diff --git a/usr/src/man/man5/pxeboot.5 b/usr/src/man/man5/pxeboot.5
deleted file mode 100644
index 0954d585bc..0000000000
--- a/usr/src/man/man5/pxeboot.5
+++ /dev/null
@@ -1,148 +0,0 @@
-.\" Copyright (c) 1999 Doug White
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
-.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\" Copyright 2018 OmniOS Community Edition (OmniOSce) Association.
-.\"
-.Dd Apr 13, 2018
-.Dt PXEBOOT 5
-.Os
-.Sh NAME
-.Nm pxeboot
-.Nd Preboot Execution Environment (PXE) bootloader
-.Sh DESCRIPTION
-The
-.Nm
-bootloader is a modified version of the system third-stage bootstrap
-.Xr loader 5
-configured to run under Intel's Preboot Execution Environment (PXE) system.
-PXE is a form of smart boot ROM, built into Ethernet cards, and
-Ethernet-equipped motherboards.
-PXE supports DHCP configuration and provides low-level NIC access services.
-.Pp
-The DHCP client will set a DHCP user class named
-.Va illumos
-to allow flexible configuration of the DHCP server.
-.Pp
-The
-.Nm
-bootloader retrieves the kernel, modules,
-and other files either via NFS over UDP or by TFTP,
-selectable through DHCP options.
-.Pp
-The
-.Nm
-binary is loaded just like any other boot file,
-by specifying it in the DHCP server's configuration file.
-Below is a sample configuration for the ISC DHCP server:
-.Bd -literal -offset indent
-option domain-name "example.com";
-option routers 10.0.0.1;
-option subnet-mask 255.255.255.0;
-option broadcast-address 10.0.0.255;
-option domain-name-servers 10.0.0.1;
-server-name "DHCPserver";
-server-identifier 10.0.0.1;
-
-default-lease-time 120;
-max-lease-time 120;
-
-subnet 10.0.0.0 netmask 255.255.255.0 {
- filename "pxeboot";
- range 10.0.0.10 10.0.0.254;
- if exists user-class and option user-class ~~ "illumos" {
- option root-path "tftp://10.0.0.1/illumos";
- }
-}
-
-.Ed
-.Pp
-.Nm
-recognizes
-.Va next-server
-and
-.Va option root-path
-directives as the server and path to NFS mount for file requests,
-respectively, or the server to make TFTP requests to.
-Note that
-.Nm
-expects to fetch
-.Pa /boot/loader.rc
-from the specified server before loading any other files.
-.Pp
-Valid
-.Cm option Va root-path
-syntax is
-.Bd -literal -offset indent
-[<scheme>://][<ip-address>/]<path>
-.Ed
-.Pp
-\&...where
-.Qq scheme
-is either
-.Qq nfs
-or
-.Qq tftp ,
-.Qq ip-address
-is the address of the server, and
-.Qq path
-is the path to the root filesystem on the server.
-If
-.Qq scheme
-is not specified,
-.Nm
-defaults to using NFS if the
-.Va root-path
-variable is in the
-.Qq Pa ip-address Ns :/ Ns Pa path
-form, otherwise TFTP is used.
-If no
-.Va root-path
-option is set in the DHCP response,
-.Nm
-defaults to using TFTP.
-.Pp
-.Nm
-defaults to a conservative 1024 byte NFS data packet size.
-This may be changed by setting the
-.Va nfs.read_size
-variable in
-.Pa /boot/loader.conf .
-Valid values range from 1024 to 16384 bytes.
-.Pp
-TFTP block size can be controlled by setting the
-.Va tftp.blksize
-variable in
-.Pa /boot/loader.conf .
-Valid values range from 8 to 9008 bytes.
-.Pp
-In all other respects,
-.Nm
-acts just like
-.Xr loader 5 .
-.Pp
-For further information on Intel's PXE specifications and Wired for
-Management (WfM) systems, see
-.Li http://www.intel.com/design/archives/wfm/ .
-.Sh SEE ALSO
-.Xr loader 5