Latest revision as of 15:29, 10 March 2014

Xen Project Configuration

Page	Description
Xen Project CLI	Command line options for Xen Project software to be used in /boot/grub/grub.conf
EFI	Configuring Xen Project software to work with EFI.

Man page	Description	Console
xl(1)	Xen Project management tool, based on LibXenlight	XL
xm(1)	Xen Project management user interface (deprecated, also see Xen 4.1 Upgrade Notes)	XM
xend-config.sxp(5)	Xen Project daemon configuration file (deprecated, also see Xen 4.1 Upgrade Notes)	XM
xl.cfg(5)	XL Domain Configuration File Syntax: to create a VM (a domain in Xen Project terminology, sometimes called a guest) with xl requires the provision of a domain config file.	XL
xl.conf(5)	XL Global/Host Configuration: allows configuration of hostwide xl toolstack options	XL
xlcpupool.cfg(5)	XL Cpupool Configuration File Syntax: to create a Cpupool with xl requires the provision of a cpupool config file.	XL
xmdomain.cfg(5)	XM domain config file format (deprecated, also see Xen 4.1 Upgrade Notes)	XM
xentop(1)	xentop displays information about the Xen Project system and domains, in a continually-updating manner.	XENTOP
xenpm(1)	Xenpm is a userspace tool that can list the power information of available processors and control the power policy according to users' preference.	XENPM

Document	Description
xl.cfg(5), disk configuration	This document specifies the xl config file format disk configuration option.
xl.cfg(5), network configuration	This document specifies the xl config file format vif configuration option.
xl.cfg(5), tsc_mode configuration	In Xen Project 4.*, a new config option called tsc_mode may be specified for each domain. This document is targeted for Xen Project users and administrators that may need to select a non-default tsc_mode.
xm.cfg(5), sEDF scheduler	The sEDF scheduler provides weighted CPU sharing in an intuitive way and uses realtime-algorithms to ensure time guarantees.
xl-numa.cfg(5), Guest Automatic NUMA placement in LIBXL and XL	This document describes the automatic placement options for NUMA hardware in XL.

Document(s)	Category	Description	Also See
Environment Variables for different Linux distros	Distros	With directory layout differences between Red Hat, Debian, Suse and other distros one needs to set the variables for CONFIG_LEAF_DIR, SUBSYS_DIR and INITD_DIR.	Distros
Distro directory layouts	Distros	Overview of the differences in directory layout between RHEL, Debian and Suse.	Distros
How to do PCI Passthrough with VT-d	PCI Passthrough		VGA Xen PCI Passthrough Overview, VT-d HowTo
Virtual TPM support	Security	This document gives a short introduction to the virtual TPM support in Xen Project and goes as far as connecting a user domain to a virtual TPM instance and doing a short test to verify success. It is assumed that the user is fairly familiar with compiling and installing the Xen Project Hypervisor and Linux on a machine.	Security Virtual Trusted Platform Module (research note)
Qemu Upstream: How to use it	QEMU	Pointer to a wiki page documenting how to build Xen Project software with the QEMU unstable tree.
sEDF scheduler how to	Scheduler / Performance	Using the SsEDF scheduler for weighted CPU sharing.	Performance
XL placement	Performance	NUMA Node placement.	Performance NUMA
VT-d HOWTO	PCI Passthrough	How to use Intel's VT-d extensions.	VGA
PVH Information	Virtualization Mode	Using the new PVH virtualization mode.	Performance Blog post
More documentation:		See Generated documents

Document(s)	Category	Description	Also See
Kexec, and kdump for Xen Project	Developers	Guide to using kexec to switch to a new kernel; and kdump for catching a dump image, with Xen Project.	Developers
Xen Project Core Dump Format	Developers	Format of the output of the x{m,l} core-dump command	Developers
Xen Project Guest Disk (VBD) interface	Developers	The interface exposed to DomUs for communicating with block devices.	Developers
Xenstore Protocol Definition	Developers	Definition of standard behaviour, when using Xenstore.	Developers
A rough introduction to using grant tables	Developers	Explanation of the data structures, and hypercalls required to share memory between domains.	Developers
Xen Project Error Handling	Developers	Explanation of the various types of error (BUG, ASSERT etc) that the hypervisor, and guest can call.	Developers
Xen Project HVM emulated device unplug protocol	Developers	Definition of the protocol used to disconnect emulated deivces, get log messages from drivers, and prevent Dom0 from loading specific drivers.	Developers
Xen Project paging	Developers	Allow the sum of memory allocated to guests > physical memory available, by paging out.	Developers
Xen Project Crash Debugger	Developers	Using gdb to analyse why Xen Hypervisor has crashed.	Developers

Note that the pages below may miss some new documents. If you do not find what you are looking for: please check the link above!

@@ Line 10: / Line 10: @@
 |-
 | [http://xenbits.xen.org/docs/4.4-testing/misc/xen-command-line.html Xen Project CLI]
-| Command line options for Xen to be used in /boot/grub/grub.conf
+| Command line options for Xen Project software to be used in /boot/grub/grub.conf
 |-
 | [http://xenbits.xen.org/docs/4.4-testing/misc/efi.html EFI]
-| Configuring Xen Project to work with EFI.
+| Configuring Xen Project software to work with EFI.
 |}
@@ Line 74: / Line 74: @@
 |-
 | [http://xenbits.xen.org/docs/4.4-testing/misc/tscmode.txt xl.cfg(5), '''tsc_mode''' configuration]
-| In Xen 4 a new config option called tsc_mode may be specified for each domain. This document is targeted for Xen users and administrators that may need to select a non-default tsc_mode.
+| In Xen Project 4.*, a new config option called tsc_mode may be specified for each domain. This document is targeted for Xen Project users and administrators that may need to select a non-default tsc_mode.
 |-
 | [http://xenbits.xen.org/docs/4.4-testing/misc/sedf_scheduler_mini-HOWTO.txt xm.cfg(5), '''sEDF scheduler''']