# HG changeset patch # User Juergen Gross # Date 1329311497 -3600 # Node ID 1bdc49548c4f6ef4bff1e726a3045a74450be3d5 # Parent 0ba87b95e80bae059fe70b4b117dcc409f2471ef Add xlcpupool.cfg man page Add a man page describing the configuration file for creating cpupools via xl cpupool-create. Signed-off-by: Juergen Gross diff -r 0ba87b95e80b -r 1bdc49548c4f docs/man/xlcpupool.cfg.pod.5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/xlcpupool.cfg.pod.5 Wed Feb 15 14:11:37 2012 +0100 @@ -0,0 +1,117 @@ +=head1 NAME + +xlcpupool.cfg - XL Cpupool Configuration File Syntax + +=head1 SYNOPSIS + + /etc/xen/xlcpupool + +=head1 DESCRIPTION + +To create a Cpupool with xl requires the provision of a cpupool config +file. Typically these live in `/etc/xen/CPUPOOL.cfg` where CPUPOOL is +the name of the cpupool. + +=head1 SYNTAX + +A cpupool config file consists of a series of C pairs. + +A value C is one of: + +=over 4 + +=item B<"STRING"> + +A string, surrounded by either single or double quotes. + +=item B + +A number, in either decimal, octal (using a C<0> prefix) or +hexadecimal (using an C<0x> prefix). + +=item B<[ VALUE, VALUE, ... ]> + +A list of C of the above types. Lists are homogeneous and are +not nested. + +=back + +The semantics of each C defines which form of C is required. + +=head1 OPTIONS + +=head2 Mandatory Configuration Items + +The following key is mandatory for any cpupool: + +=over 4 + +=item B + +Specifies the name of the cpupool. Names of cpupools existing on a +single host must be unique. + +=back + +=head2 Optional Configuration Items + +The following options apply to guests of any type. + +=over 4 + +=item B + +Specifies the scheduler which is used for the cpupool. Valid +values for C are: + +=over 4 + +=item B + +the credit scheduler + +=item B + +the credit2 scheduler + +=item B + +the SEDF scheduler + +=back + +The default scheduler is the one used for C specified as +boot parameter of the hypervisor. + +=item B + +Specifies the cpus of the NUMA-nodes given in C (an integer or +a list of integers) to be member of the cpupool. The free cpus in the +specified nodes are allocated in the new cpupool. + +=item B + +The specified C are allocated in the new cpupool. All cpus must +be free. Must not be specified together with B. + +If neither B nor B are specified only the first free cpu +found will be allocated in the new cpupool. + +=back + +=head1 FILES + +F + +=head1 BUGS + +This document is a work in progress and contains items which require +further documentation and which are generally incomplete (marked with +XXX). However all options are included here whether or not they are +fully documented. + +Patches to improve incomplete items (or any other item) would be +greatfully received on the xen-devel@xxxxxxxxxxxxxxxxxxx mailing +list. Please see L for +information on how to submit a patch to Xen. +