NAME

pxelinux - The LCFG pxelinux component

DESCRIPTION

LCFG component to configure a pxelinux server

RESOURCES

labels

The list of boot labels

title_tag

Use this if you want a label name that is not a valid LCFG identifier, e.g. a title of "foo-bar" and label "foobar".

kernel_tag

The kernel image to boot with for this label.

initrd_tag

An optional initrd image to use with this kernel image.

root_tag

An optional root argument to pass in to the kernel.

init_tag

An optional init argument to pass in to the kernel.

options_tag

Any further options you want to pass in to the kernel.

descr_tag

A description of the label which will be applied to the standard templated display file.

timeout

Indicates how long to wait at the boot: prompt until booting automatically, in units of 1/10 s. The timeout is cancelled as soon as the user types anything on the keyboard, the assumption being that the user will complete the command line already begun. A timeout of zero will disable the timeout completely. The default is 100.

defaultlabel

The boot label that will be selected as default if the user does not select one.

prompt

If prompt is 0, display the boot: prompt only if the Shift or Alt key is pressed, or Caps Lock or Scroll lock is set. If prompt is 1, always display the boot: prompt. The default value is 1.

display

Displays the indicated file on the screen at boot time (before the boot: prompt, if displayed). Default file name is lcfgbootblurb. The file should be placed in the pxelinux.tftpdir directory.

NOTE: If the file is missing, this option is simply ignored.

allowoptions

If allowoptions is 0, ignore any options added by the user on the command line. The default is 1.

tftpdir

The directory in which the pxelinux binary and configuration files must be placed so that they can be found by the tftp server. The default tftp directory is /tftpboot.

pxelinux_path

This is the path to the pxelinux binary on the pxe server. A symlink will be created to it with the name pxelinux, inside the pxelinux.tftpdir directory. On Redhat and Fedora systems you will probably need to install the syslinux package. The default path to the pxelinux binary is /usr/lib/syslinux/pxelinux.0.

The pxelinux component is based on the file component and as such it also supports the following resources: files, file_tag, type_tag, tmpl_tag, owner_tag, group_tag, mode_tag. See the lcfg-file manpage for full details. These resources can be used to control the files created in the pxelinux.cfg directory.

The pxelinux component creates a file in the directory pxelinux.tftpdir/pxelinux.cfg named "default". This allows access to the PXE boot for any machines, you can restrict the access by changing this to a different file name based on the subnet or IP address. See the web page http://syslinux.zytor.com/pxe.php for full details.

EXAMPLES

/* Add an fc3 boot label */
pxelinux.defaultlabel fc3
pxelinux.labels fc3 fc5 serial

pxelinux.kernel_fc3           /dicefc3install/vmlinuz
pxelinux.initrd_fc3           /dicefc3install/initrd.gz
pxelinux.root_fc3             /dev/ram0
pxelinux.init_fc3             /linuxrc
pxelinux.options_fc3          ramdisk_size=106800 rw
pxelinux.descr_fc3            boot to the fc3 install system

/* Configure pxelinux */

/* Change from using the "default" pxelinux config file
   This restricts access to specified subnets/addresses */

!pxelinux.file_conf mSET(<%pxelinux.file_pxedir%>/81D7)

/* Add another subnet which is just a symlink to the
   standard config */

!pxelinux.files  mADD(81D719)
pxelinux.file_81D719 <%pxelinux.file_pxedir%>/81D719
pxelinux.type_81D719 link
pxelinux.tmpl_81D719 <%pxelinux.file_pxedir%>/81D7

PLATFORMS

Fedora5

AUTHOR

Stephen Quinney <squinney@inf.ed.ac.uk>