trunk/man/fai-chboot.8

.\"                                      Hey, EMACS: -*- nroff -*-
.TH fai-chboot 8 "15 september" "FAI 3"
.SH NAME
fai-chboot \- manage the network boot configuration files
.SH SYNOPSIS
.B fai-chboot
[OPTION]... KERNELNAME ROOTFS HOST...
.br
.B fai-chboot
-l [-e|-r|-t|-o|-g] [PATTERN]
.br
.B fai-chboot
-e HOST...
.br
.B fai-chboot
-r HOST...
.br
.B fai-chboot
-c HOST|TEMPLATE HOST...
.br
.B fai-chboot
-i [OPTION]... HOST...
.br
.B fai-chboot
-I [OPTION]... HOST...
.SH DESCRIPTION
This command creates the configuration files for network booting.

KERNELNAME is the file name of the kernel that will be booted. This
kernel will mount the root filesystem from device ROOTFS. You can add
additional kernel parameters and define some FAI specific flags. For
each host one configuration file is created. The file name of the
configuration file is its IP address in upper case hexadecimal. HOST
can be a host name or an IP address.

.SH OPTIONS
.TP
.BI \-B
Set default values for FAI_FLAGS. This is the same as -f
verbose,sshd,reboot
.TP
.B \-c
Copy an existing config file to one or more hosts or templates and enable
them for network booting.
.TP
.BI "\-D " DIR
Set the default directory for the network boot configuration to
DIR. The default value is /srv/tftp/pxelinux.cfg/.
.TP
.B \-e
Reenable network booting for HOST. This renames the config file and removes
the suffix .disable from it, so the next time it uses the old PXE configuration.
.TP
.BI "\-f " fai_flags
Set FAI_FLAGS. The flags must be comma separated.
.TP
.BI \-F
Set default values for FAI_FLAGS. This is the same as -f
verbose,sshd,createvt
.TP
.B \-h
Show simle help and version.
.TP
.B \-i
Set parameters for booting the FAI install kernel. Same as -k "ip=dhcp" vmlinuz-install /dev/nfs. This does not set FAI_ACTION.
.TP
.B \-I
Same as -i but also sets FAI_ACTION=install. So a fully automatic
installation will be performed. ATTENTION! This will erase most of the
data on the install clients local disks.
.TP
.BI "\-k " parameters
Set kernel append parameters.
.TP
.B \-l
List the configuration for all hosts in short format. If PATTERN is
given, list only hosts matching PATTERN. Lists hostname, FAI_ACTION,
kernel name and IP address in hex. With \fB\-l\fR, list only enabled hosts. 
With \fB-d\fR list only disabled hosts.
With \fB-t\fR list only templates.
With \fB-o\fR list only hosts that does not match any of the other categories. 
With \fB-g\fR list the configuration for all hosts, sorted and ordered by 
groups (enabled, disabled, templates, others).
.TP
.B \-L
List the configuration for all hosts. Also list the kernel append parameters.
If PATTERN is given, list only hosts matching PATTERN.
.TP
.B \-n
Do not create configuration but show what will be done. This also
enables the verbose flag.
.TP
.BI \-o
Do localboot via PXE. Do not boot via network card, but use next boot
device which is specified in the BIOS. Normally this is the local disk.
.TP
.B \-p
Preserve existing config files. The default is to overwrite an
existing config file.
.TP
.B \-d
Disable network booting for HOST. This renames the config file and adds
the suffix .disable to it.
.TP
.BI \-S
Same as -i but also sets FAI_ACTION=sysinfo.
.TP
.B \-v
Create verbose output.
.SH EXAMPLES
.TP
fai-chboot -l
List the configuration for all hosts.
.TP
fai-chboot -iFv atom02 atom03 dom kueppers
The hosts atom02, atom03, dom and kueppers will boot the FAI install
kernel. FAI_ACTION will not be set unless specified with option
-k or -I. You can also use the script class/LAST.var on the install server
to set FAI_ACTION.
.TP
fai-chboot -FSv atom02
The host atom02 will boot the FAI install kernel but with FAI_ACTION sysinfo.
.TP
fai-chboot -IBv atom02
The host atom02 will be installed. ATTENTION! All data on the local
hard disks are lost in most cases, because we want to install a new
system. After the installation the host automatically reboots.
.TP
fai-chboot -v atom-localboot /dev/hda1 atom03 
Next time atom03 will boot the kernel atom-localboot which mounts the
root filesystem from /dev/hda1.
.TP
fai-chboot memtest86+ koeln atom02
The host atom02 will boot the memory test. Install the package
memtest86+ and copy the executable memtest86+.bin to /srv/tftp/fai. Since
memtest does not need a root filesystem, you can use any string for it.
.TP
fai-chboot -o default
All hosts, that do not have a PXE configuration for their IP-address
will do a localboot, means booting from local disk.

.SH NOTES
Currently only PXE boot is supported. BOOTP configuration can be
managed using the tlink utility.

.SH SEE ALSO
.br
This program is part of FAI (Fully Automatic Installation).  See the FAI manual
for more information on how to use fcopy.  The FAI homepage is http://www.informatik.uni-koeln.de/fai.

.SH AUTHOR
Thomas Lange <lange@informatik.uni-koeln.de>
1	lange	1820	.\" Hey, EMACS: -- nroff --
2	lange	3959	.TH fai-chboot 8 "15 september" "FAI 3"
3	lange	1820	.SH NAME
4	lange	1830	fai-chboot \- manage the network boot configuration files
5	lange	1820	.SH SYNOPSIS
6	lange	1830	.B fai-chboot
7			[OPTION]... KERNELNAME ROOTFS HOST...
8			.br
9			.B fai-chboot
10	lange	3362	-l [-e\|-r\|-t\|-o\|-g] [PATTERN]
11	lange	1830	.br
12			.B fai-chboot
13	lange	2446	-e HOST...
14			.br
15			.B fai-chboot
16	lange	1830	-r HOST...
17			.br
18			.B fai-chboot
19	lange	3362	-c HOST\|TEMPLATE HOST...
20			.br
21			.B fai-chboot
22	lange	1830	-i [OPTION]... HOST...
23	lange	2885	.br
24			.B fai-chboot
25			-I [OPTION]... HOST...
26	lange	1820	.SH DESCRIPTION
27			This command creates the configuration files for network booting.
28
29			KERNELNAME is the file name of the kernel that will be booted. This
30			kernel will mount the root filesystem from device ROOTFS. You can add
31			additional kernel parameters and define some FAI specific flags. For
32			each host one configuration file is created. The file name of the
33			configuration file is its IP address in upper case hexadecimal. HOST
34			can be a host name or an IP address.
35
36			.SH OPTIONS
37			.TP
38	lange	1945	.BI \-B
39			Set default values for FAI_FLAGS. This is the same as -f
40	lange	3412	verbose,sshd,reboot
41	lange	1945	.TP
42	lange	3362	.B \-c
43			Copy an existing config file to one or more hosts or templates and enable
44			them for network booting.
45			.TP
46	lange	3863	.BI "\-D " DIR
47	lange	1820	Set the default directory for the network boot configuration to
48	lange	3557	DIR. The default value is /srv/tftp/pxelinux.cfg/.
49	lange	1820	.TP
50	lange	2446	.B \-e
51			Reenable network booting for HOST. This renames the config file and removes
52			the suffix .disable from it, so the next time it uses the old PXE configuration.
53			.TP
54	lange	1820	.BI "\-f " fai_flags
55			Set FAI_FLAGS. The flags must be comma separated.
56			.TP
57			.BI \-F
58			Set default values for FAI_FLAGS. This is the same as -f
59	lange	3412	verbose,sshd,createvt
60	lange	1820	.TP
61			.B \-h
62			Show simle help and version.
63			.TP
64			.B \-i
65	lange	3959	Set parameters for booting the FAI install kernel. Same as -k "ip=dhcp" vmlinuz-install /dev/nfs. This does not set FAI_ACTION.
66	lange	1820	.TP
67	lange	1851	.B \-I
68	lange	2160	Same as -i but also sets FAI_ACTION=install. So a fully automatic
69	lange	1851	installation will be performed. ATTENTION! This will erase most of the
70			data on the install clients local disks.
71			.TP
72	lange	1830	.BI "\-k " parameters
73			Set kernel append parameters.
74			.TP
75	lange	1820	.B \-l
76	lange	3255	List the configuration for all hosts in short format. If PATTERN is
77			given, list only hosts matching PATTERN. Lists hostname, FAI_ACTION,
78	lange	3362	kernel name and IP address in hex. With \fB\-l\fR, list only enabled hosts.
79	lange	3863	With \fB-d\fR list only disabled hosts.
80	lange	3362	With \fB-t\fR list only templates.
81			With \fB-o\fR list only hosts that does not match any of the other categories.
82			With \fB-g\fR list the configuration for all hosts, sorted and ordered by
83			groups (enabled, disabled, templates, others).
84	lange	1820	.TP
85	lange	1847	.B \-L
86			List the configuration for all hosts. Also list the kernel append parameters.
87	lange	3255	If PATTERN is given, list only hosts matching PATTERN.
88	lange	1847	.TP
89	lange	1820	.B \-n
90			Do not create configuration but show what will be done. This also
91			enables the verbose flag.
92			.TP
93	lange	2212	.BI \-o
94			Do localboot via PXE. Do not boot via network card, but use next boot
95			device which is specified in the BIOS. Normally this is the local disk.
96			.TP
97	lange	1830	.B \-p
98			Preserve existing config files. The default is to overwrite an
99			existing config file.
100	lange	1820	.TP
101	lange	3863	.B \-d
102	lange	2446	Disable network booting for HOST. This renames the config file and adds
103	lange	1820	the suffix .disable to it.
104			.TP
105	lange	2147	.BI \-S
106	lange	2160	Same as -i but also sets FAI_ACTION=sysinfo.
107	lange	2147	.TP
108	lange	1820	.B \-v
109			Create verbose output.
110			.SH EXAMPLES
111			.TP
112			fai-chboot -l
113			List the configuration for all hosts.
114			.TP
115			fai-chboot -iFv atom02 atom03 dom kueppers
116	lange	1847	The hosts atom02, atom03, dom and kueppers will boot the FAI install
117			kernel. FAI_ACTION will not be set unless specified with option
118	lange	1875	-k or -I. You can also use the script class/LAST.var on the install server
119	lange	1847	to set FAI_ACTION.
120	lange	1820	.TP
121	lange	2171	fai-chboot -FSv atom02
122	lange	1847	The host atom02 will boot the FAI install kernel but with FAI_ACTION sysinfo.
123			.TP
124	lange	1945	fai-chboot -IBv atom02
125	lange	1875	The host atom02 will be installed. ATTENTION! All data on the local
126	lange	1945	hard disks are lost in most cases, because we want to install a new
127			system. After the installation the host automatically reboots.
128	lange	1875	.TP
129	lange	1830	fai-chboot -v atom-localboot /dev/hda1 atom03
130			Next time atom03 will boot the kernel atom-localboot which mounts the
131	lange	2257	root filesystem from /dev/hda1.
132	lange	1820	.TP
133	lange	2423	fai-chboot memtest86+ koeln atom02
134	lange	1881	The host atom02 will boot the memory test. Install the package
135	lange	3557	memtest86+ and copy the executable memtest86+.bin to /srv/tftp/fai. Since
136	lange	2212	memtest does not need a root filesystem, you can use any string for it.
137			.TP
138			fai-chboot -o default
139			All hosts, that do not have a PXE configuration for their IP-address
140			will do a localboot, means booting from local disk.
141	lange	1820
142			.SH NOTES
143			Currently only PXE boot is supported. BOOTP configuration can be
144			managed using the tlink utility.
145
146			.SH SEE ALSO
147			.br
148			This program is part of FAI (Fully Automatic Installation). See the FAI manual
149			for more information on how to use fcopy. The FAI homepage is http://www.informatik.uni-koeln.de/fai.
150
151			.SH AUTHOR
152			Thomas Lange <lange@informatik.uni-koeln.de>
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision