aboutsummaryrefslogtreecommitdiffstats
path: root/docs/man/xl.conf.pod.5
blob: 31aebcaa9093b96f4ffc764867eadf2fc591537f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
=head1 NAME

/etc/xen/xl.conf - XL Global/Host Configuration 

=head1 DESCRIPTION

The F<xl.conf> file allows configuration of hostwide C<xl> toolstack
options.

For details of per-domain configuration options please see
L<xl.cfg(5)>.

=head1 SYNTAX

The config file consists of a series of C<KEY=VALUE> pairs.

A value C<VALUE> is one of:

=over 4

=item B<"STRING">

A string, surrounded by either single or double quotes.

=item B<NUMBER>

A number, in either decimal, octal (using a C<0> prefix) or
hexadecimal (using an C<0x> prefix).

=item B<BOOLEAN>

A C<NUMBER> interpreted as C<False> (C<0>) or C<True> (any other
value).

=item B<[ VALUE, VALUE, ... ]>

A list of C<VALUES> of the above types. Lists are homogeneous and are
not nested.

=back

The semantics of each C<KEY> defines which form of C<VALUE> is required.

=head1 OPTIONS

=over 4

=item B<autoballoon=BOOLEAN>

If disabled then C<xl> will not attempt to reduce the amount of memory
assigned to domain 0 in order to create free memory when starting a
new domain. You are strongly recommended to set this to C<0>
(C<False>) if you use the C<dom0_mem> hypervisor command line to
reduce the amount of memory given to domain 0 by default.

Default: C<1>

=item B<run_hotplug_scripts=BOOLEAN>

If disabled hotplug scripts will be called from udev, as it used to
be in the previous releases. With the default option, hotplug scripts
will be launched by xl directly.

Default: C<1>

=item B<lockfile="PATH">

Sets the path to the lock file used by xl to serialise certain
operations (primarily domain creation).

Default: C</var/lock/xl>

=item B<vifscript="PATH">

Configures the default hotplug script used by virtual network devices.

Default: C</etc/xen/scripts/vif-bridge>

=item B<vif.default.bridge="NAME">

Configures the default bridge to set for virtual network devices.

The old B<defaultbridge> option is deprecated and should not be used.

Default: C<xenbr0>

=item B<vif.default.gatewaydev="NAME">

Configures the default gateway device to set for virtual network devices.

Default: C<None>

=item B<output_format="json|sxp">

Configures the default output format used by xl when printing "machine
readable" information. The default is to use the C<JSON>
L<http://www.json.org/> syntax. However for compatibility with the
previous C<xm> toolstack this can be configured to use the old C<SXP>
(S-Expression-like) syntax instead.

Default: C<json>

=item B<blkdev_start="NAME">

Configures the name of the first block device to be used for temporary
block device allocations by the toolstack.
The default choice is "xvda".

=back

=head1 SEE ALSO

=over 4

=item L<xl(1)>

=item L<xl.cfg(5)>

=item http://www.json.org/

=back