Variables

The following Variables do exist in FAI (example values included):

Please do not edit that much, without contacting Mrfai. Currently it's my private list of variable and comments.

type: int = internal use only; CS used in config space (often defined by *.var)

name	type	example value	created by	used by	comments
BROADCAST		192.168.0.127	get-boot-info	scripts/FAIBASE/30-interface
DNSDOMAIN		workgroup.de	task_setup()		justdefined because cfengine 1.5.3 can't use DOMAIN
DNSSRVS		192.168.1.16	get-boot-info	create_resolv_conf
DNSSRVS_1		192.168.1.16	get-boot-info		first element of DNSSRV
DOMAIN		workgroup.de	get-boot-info	task_setup() task_prepareapt()
NETMASK		255.255.255.128	get-boot-info
NETWORK		192.168.0.0	get-boot-info
IPADDR		192.168.0.14	get-boot-info
GATEWAYS		192.168.0.1	get-boot-info
GATEWAYS_1		192.168.0.1	get-boot-info
--
BOOT_IMAGE	int	vmlinux-install	kernel	no one	may be unset
COLOR_FAI_LOGO	int	boolean		prcopyleft()	Only the Linux Terminal can display the color logo.
DEBIAN_FRONTEND	int	noninteractive		dpkg -i
DO_INIT_TASKS	int	boolean		fai, task_confdir(), prcopyleft()	1 if doing net installation
--
FAI		/fai	fai.conf	almost every function
FAI_ACTION		install, sysinfo, softupdate	fai-chboot via kernel command line	save_log_local() save_log_remote_shell() save_log_remote() get_bootp_info() task_action(), fai-savelog-ftp, updatebase
FAI_FLAGS		'createvt sshd'	kernel command line, fai-chboot	define_fai_flags()	rename flags, e.g $flag_sshd
FAI_LOCATION		faiserver:/srv/fai/config		get_bootp_info() get_fai_dir() get_fai_cvs()
FAI_LOGPROTO		ftp	fai.conf	save_log_remote()	replaces FAI_REMOVECP and FAI_REMOTESH, may be removed from fai.conf, should be defined in class/*.var, but fai-setup needs this too, maybe add option to fai-setup that determines if ssh/rsh should be set up
FAI_REMOTECP		scp	fai.conf	fai-setup, fai-savelog	removed from fai.conf
FAI_REMOTESH		ssh	fai.conf	fai-setup, fai-savelog, task_chboot()	removed from fai.conf
FAI_ROOT	const	/tmp/target	bin/fai	almost every script
FAI_RUNDATE	int	20060123_163824	task_setup()	fai-savelog
FAI_VERSION	const	FAI 2.10.5		fai, prcopyleft()
FAI_BOOT		dhcp bootp		fai-setup	removed from fai.conf, now using default value
FAI_CONFIGDIR	int	/srv/fai/config	fai.conf	*.postinst, fai-setup, fai-cd, fai-mirror, make-fai-nfsroot	used in $FAI_LOCATION
HOSTNAME		demohost		very often	may the hostname change during installtion? Is the hostname FQDN in some cases? numeric hostname if host-decl-name off in dhcpd.conf
HOSTTYPE	int	x86_64	bash variable	prcopyleft
LOGDIR		/tmp/fai	fai	very often
LOGPASSWD			fai.conf, *.var	fai-savelog-ftp	maybe removed from fai.conf
LOGREMOTEDIR		upload	fai.conf, *.var	fai-savelog-ftp	maybe removed from fai.conf
LOGSERVER			fai.conf	fai-savelog, fai-savelog-ftp	default: LOGSERVER=$SERVER, remove from fai.conf
LOGUSER		fai	fai.conf	fai-setup, fai-savelog, fai-savelog-ftp,task_chboot()	default: LOGUSER= will disable logging
MNTPOINT		/var/lib/fai/mirror		/make-fai-nfsroot, fai-mirror, task_mirror()	now a fixed path?
NFSROOT		/srv/fai/nfsroot/	fai.conf	fai-setup, make-fai-nfsroot, fai-cd, fai-mirror	not needed in $NFSROOT, only needed on the install server
PATH	int	/usr/local/sbin:...	fai
SERVERINTERFACE		eth0	fai.conf		only needed when install server has multiple interfaces, maybe used to determine $installserver
installserver		kueppers	fai.conf	only for building FAI_LOCATION	unset very early, can be removed
mirrorhost		192.168.0.8	fai.conf	make-fai-nfsroot.conf,$FAI_DEBOOTSTRAP, $FAI_DEBMIRROR, NFSROOT_ETC_HOSTS	may be removed
FAI_DEBMIRROR		$mirrorhost:/srv/debmirror	fai.conf		move to make-fai-nfsroot.conf, but needed in $NFSROOT/../fai.conf
--
HOST		demohost	given on kernel command line		can redefine host name
cfclasses	int	DEFAULT.LINUX.LAST		cfagent scripts
classes	int	DEFAULT LINUX LAST		almost every script
device_size	int	'sda 71687372'		set_disk_info()	all disks and their sizes; may become local variable
disklist		sda	set_disk_info()	setup_harddisks, fai-mount-disk
SERVER		kueppers
faimond	int	0			determines if faimond is running, merge $faimond and $monserver
monserver		kueppers	task_confdir	sndmon()	default: monserver=$SERVER, may be removed, but must be set very early (e.g in fai.conf)
fstab	int	fstab		was used for solaris, fstab -> vfstab	can be removed
ip	int	dhcp		get-boot-info	may be unset after use
--
netdevices	int	eth0	get-boot-info	get-boot-info, task_sysinfo, dhclient-fai-script
netdevices_all	int	eth0 eth1	get-boot-info	get-boot-info, task_sysinfo
netdevices_up		eth0	get-boot-info	get-boot-info, task_sysinfo
nfsroot	int	/srv/fai/nfsroot/	fai-chboot via kernel append parameter	kernel, fai-chboot	may contain server's IP address
renewclass	int	boolean		task_defclass()	on softupdate recalculate the list of classes, unset after use
romountopt	int	-o async,noatime,ro			unset after use
sndhostname			task_confdir()	sndmon()	sndhostname=$HOSTNAME; client's hostname, do not replace with $HOSTNAME, since HOSTNAME may change during installation
sshd		boolean	define_fai_flags()
createvt		boolean	define_fai_flags()
terror	int	integer		every task can set it
target		/tmp/target			same as $FAI_ROOT
ROOTCMD		'chroot /tmp/target'		almost every script
diskvar	int	$LOGDIR/disk_var.sh			contains $BOOT_PARTITION, $ROOT_PARTITION, $BOOT_DEVICE, $SWAPLIST, use $LOGDIR/disk_var.sh instead of additional variable, may be removed
lpipe	int	/tmp/fai/logfifo			variable removed, try to remove the ugly hack using it
rundir	int	/var/run/fai	fai	get_fai_dir(), fai	maybe replaced by fixed path
stamp	int	..._IN_PROGRESS
rcslog	int	$LOGDIR/fai.log			replaced by $LOGDIR/fai.log
FAI_CONSOLEFONT	CS		class/*.var
FAI_KEYMAP	CS	de	class/*.var
BOOT_PARTITION	CS	/dev/sda1	setup_harddisks	grub/menu.lst/postinst
ROOT_PARTITION	CS	/dev/sda1	setup_harddisks	LILO/20-create-liloconf
UTC	CS	yes	class/*.var	example/simple/scripts
time_zone	CS	Europe/Berlin	class/*.var	example/simple/scripts
liloappend	CS		class/*.var	20-create-liloconf
moduleslist	CS	psmouse	class/*.var	scripts/FAIBASE/10-misc