Skip to content

L
libvirt

openeuler / libvirt

通知 3
Star 0
Fork 0
L
libvirt

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

切换分支/标签
查找文件 普通视图历史永久链接Permalink
formatdomain.html.in 67.6 KB
Newer Older
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
1 2 3 4 
<html>
  <body>
    <h1>Domain XML format</h1>
D
Update domain XML docs  
Daniel P. Berrange 已提交
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 
    <ul id="toc"></ul>

    <p>
      This section describes the XML format used to represent domains, there are
      variations on the format based on the kind of domains run and the options
      used to launch them. For hypervisor specific details consult the
      <a href="drivers.html">driver docs</a>
    </p>


    <h2><a name="elements">Element and attribute overview</a></h2>

    <p>
      The root element required for all virtual machines is
      named <code>domain</code>. It has two attributes, the
      <code>type</code> specifies the hypervisor used for running
      the domain. The allowed values are driver specific, but
      include "xen", "kvm", "qemu", "lxc" and "kqemu". The
      second attribute is <code>id</code> which is a unique
      integer identifier for the running guest machine. Inactive
      machines have no id value.
    </p>


    <h3><a name="elementsMetadata">General metadata</a></h3>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
31 32 33 34 
<pre>
&lt;domain type='xen' id='3'&gt;
  &lt;name&gt;fv0&lt;/name&gt;
  &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
C
docs: domain: Document <description> element  
Cole Robinson 已提交
35 
  &lt;description&gt;Some human readable description&lt;/description&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
36 
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
37 38 39 40 

    <dl>
      <dt><code>name</code></dt>
      <dd>The content of the <code>name</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
41 42 43 44 45 
        a short name for the virtual machine. This name should
        consist only of alpha-numeric characters and is required
        to be unique within the scope of a single host. It is
        often used to form the filename for storing the persistent
        configuration file. <span class="since">Since 0.0.1</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
46 47 
      <dt><code>uuid</code></dt>
      <dd>The content of the <code>uuid</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
48 49 50 
        a globally unique identifier for the virtual machine.
        The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
        If omitted when defining/creating a new machine, a random
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
51 52 53 54 
        UUID is generated. It is also possible to provide the UUID
        via a <a href="#elementsSysinfo"><code>sysinfo</code></a>
        specification. <span class="since">Since 0.0.1, sysinfo
        since 0.8.7</span></dd>
C
docs: domain: Document <description> element  
Cole Robinson 已提交
55 56 57 58 59 60 

      <dt><code>description</code></dt>
      <dd>The content of the <code>description</code> element provides a
      human readable description of the virtual machine. This data is not
      used by libvirt in any way, it can contain any information the user
      wants. <span class="since">Since 0.7.2</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 
    </dl>

    <h3><a name="elementsOS">Operating system booting</a></h3>

    <p>
      There are a number of different ways to boot virtual machines
      each with their own pros and cons.
    </p>

    <h4><a name="elementsOSBIOS">BIOS bootloader</a></h4>

    <p>
      Booting via the BIOS is available for hypervisors supporting
      full virtualization. In this case the BIOS has a boot order
      priority (floppy, harddisk, cdrom, network) determining where
      to obtain/find the boot image.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
79 80 81 82 83 84 
<pre>
  ...
  &lt;os&gt;
    &lt;type&gt;hvm&lt;/type&gt;
    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
    &lt;boot dev='hd'/&gt;
C
qemu: Allow setting boot menu on/off  
Cole Robinson 已提交
85 86 
    &lt;boot dev='cdrom'/&gt;
    &lt;bootmenu enable='yes'/&gt;
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
87 
    &lt;smbios mode='sysinfo'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
88 89 
  &lt;/os&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
90 91 92 93 

    <dl>
      <dt><code>type</code></dt>
      <dd>The content of the <code>type</code> element specifies the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
94 95 96 97 98 99 100 101 
        type of operating system to be booted in the virtual machine.
        <code>hvm</code> indicates that the OS is one designed to run
        on bare metal, so requires full virtualization. <code>linux</code>
        (badly named!) refers to an OS that supports the Xen 3 hypervisor
        guest ABI. There are also two optional attributes, <code>arch</code>
        specifying the CPU architecture to virtualization, and <code>machine</code>
        referring to the machine type. The <a href="formatcaps.html">Capabilities XML</a>
        provides details on allowed values for these. <span class="since">Since 0.0.1</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
102 103 
      <dt><code>loader</code></dt>
      <dd>The optional <code>loader</code> tag refers to a firmware blob
M
Cleanup whitespace in docs  
Matthew Booth 已提交
104 105 
        used to assist the domain creation process. At this time, it is
        only needed by Xen fully virtualized domains. <span class="since">Since 0.1.0</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
106 107 
      <dt><code>boot</code></dt>
      <dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
M
Cleanup whitespace in docs  
Matthew Booth 已提交
108 109 
        "cdrom" or "network" and is used to specify the next boot device
        to consider. The <code>boot</code> element can be repeated multiple
J
Introduce per-device boot element  
Jiri Denemark 已提交
110 111 112 113 114 
        times to setup a priority list of boot devices to try in turn. The
        <code>boot</code> element cannot be used if per-device boot elements
        are used (see <a href="#elementsDisks">disks</a> and
        <a href="#elementsNICS">network interfaces</a> sections below.
        <span class="since">Since 0.1.3, per-device boot since 0.8.8</span>
D
Update domain XML docs  
Daniel P. Berrange 已提交
115 
      </dd>
C
qemu: Allow setting boot menu on/off  
Cole Robinson 已提交
116 117 118 119 120 121 
      <dt><code>bootmenu</code></dt>
      <dd> Whether or not to enable an interactive boot menu prompt on guest
      startup. The <code>enable</code> attribute can be either "yes" or "no".
      If not specified, the hypervisor default is used. <span class="since">
      Since 0.8.3</span>
      </dd>
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
122 123 124 125 126 127 128 129 130 131 
      <dt><code>smbios</code></dt>
      <dd>How to populate SMBIOS information visible in the guest.
      The <code>mode</code> attribute must be specified, and is either
      "emulate" (let the hypervisor generate all values), "host" (copy
      all of Block 0 and Block 1, except for the UUID, from the host's
      SMBIOS values), or "sysinfo" (use the values in
      the <a href="#elementsSysinfo">sysinfo</a> element).  If not
      specified, the hypervisor default is used. <span class="since">
      Since 0.8.7</span>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
132 133 134 135 136 137 138 
    </dl>

    <h4><a name="elementsOSBootloader">Host bootloader</a></h4>

    <p>
      Hypervisors employing paravirtualization do not usually emulate
      a BIOS, and instead the host is responsible to kicking off the
A
fix typos in docs  
Atsushi SAKAI 已提交
139 
      operating system boot. This may use a pseudo-bootloader in the
D
Update domain XML docs  
Daniel P. Berrange 已提交
140 141 142 143 
      host to provide an interface to choose a kernel for the guest.
      An example is <code>pygrub</code> with Xen.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
144 145 146 147 148 
<pre>
  ...
  &lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
  &lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
149 150 151 152 

    <dl>
      <dt><code>bootloader</code></dt>
      <dd>The content of the <code>bootloader</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
153 154 155 156 
        a fully qualified path to the bootloader executable in the
        host OS. This bootloader will be run to choose which kernel
        to boot. The required output of the bootloader is dependent
        on the hypervisor in use. <span class="since">Since 0.1.0</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
157 158 
      <dt><code>bootloader_args</code></dt>
      <dd>The optional <code>bootloader_args</code> element allows
M
Cleanup whitespace in docs  
Matthew Booth 已提交
159 160 161 
        command line arguments to be passed to the bootloader.
        <span class="since">Since 0.2.3</span>
        </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
162 163 164 165 166 167 168 169 170 171 172 173 

    </dl>

    <h4><a name="elementsOSKernel">Direct kernel boot</a></h4>

    <p>
      When installing a new guest OS it is often useful to boot directly
      from a kernel and initrd stored in the host OS, allowing command
      line arguments to be passed directly to the installer. This capability
      is usually available for both para and full virtualized guests.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
174 175 176 177 178 179 180 181 182 183 
<pre>
  ...
  &lt;os&gt;
    &lt;type&gt;hvm&lt;/type&gt;
    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
    &lt;kernel&gt;/root/f8-i386-vmlinuz&lt;/kernel&gt;
    &lt;initrd&gt;/root/f8-i386-initrd&lt;/initrd&gt;
    &lt;cmdline&gt;console=ttyS0 ks=http://example.com/f8-i386/os/&lt;/cmdline&gt;
  &lt;/os&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
184 185 186 187 

    <dl>
      <dt><code>type</code></dt>
      <dd>This element has the same semantics as described earlier in the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
188 
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
189 
      <dt><code>loader</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
190 
      <dd>This element has the same semantics as described earlier in the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
191 
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
192 193 
      <dt><code>kernel</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Cleanup whitespace in docs  
Matthew Booth 已提交
194 
        to the kernel image in the host OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
195 196 
      <dt><code>initrd</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Cleanup whitespace in docs  
Matthew Booth 已提交
197 
        to the (optional) ramdisk image in the host OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
198 199 
      <dt><code>cmdline</code></dt>
      <dd>The contents of this element specify arguments to be passed to
M
Cleanup whitespace in docs  
Matthew Booth 已提交
200 201 202 
        the kernel (or installer) at boottime. This is often used to
        specify an alternate primary console (eg serial port), or the
        installation media source / kickstart file</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
203 204 
    </dl>
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 
    <h3><a name="elementsSysinfo">SMBIOS System Information</a></h3>

    <p>
      Some hypervisors allow control over what system information is
      presented to the guest (for example, SMBIOS fields can be
      populated by a hypervisor and inspected via
      the <code>dmidecode</code> command in the guest).  The
      optional <code>sysinfo</code> element covers all such categories
      of information. <span class="since">Since 0.8.7</span>
    </p>

<pre>
  ...
  &lt;os&gt;
    &lt;smbios mode='sysinfo'/&gt;
    ...
  &lt;/os&gt;
  &lt;sysinfo type='smbios'&gt;
    &lt;bios&gt;
      &lt;entry name='vendor'&gt;LENOVO&lt;/entry&gt;
    &lt;/bios&gt;
    &lt;system&gt;
      &lt;entry name='manufacturer'&gt;Fedora&lt;/entry&gt;
      &lt;entry name='vendor'&gt;Virt-Manager&lt;/entry&gt;
    &lt;/system&gt;
  &lt;/sysinfo&gt;
  ...</pre>

    <p>
      The <code>sysinfo</code> element has a mandatory
      attribute <code>type</code> that determine the layout of
      sub-elements, with supported values of:
    </p>

    <dl>
      <dt><code>smbios</code></dt>
      <dd>Sub-elements call out specific SMBIOS values, which will
      affect the guest if used in conjunction with
      the <code>smbios</code> sub-element of
      the <a href="#elementsOS"><code>os</code></a> element.  Each
      sub-element of <code>sysinfo</code> names a SMBIOS block, and
      within those elements can be a list of <code>entry</code>
      elements that describe a field within the block.  The following
      blocks and entries are recognized:
        <dl>
          <dt><code>bios</code></dt>
          <dd>
            This is block 0 of SMBIOS, with entry names drawn from
            "vendor", "version", "date", and "release".
          </dd>
          <dt><code>system</code></dt>
          <dd>
            This is block 1 of SMBIOS, with entry names drawn from
            "manufacturer", "product", "version", "serial", "uuid",
            "sku", and "family".  If a "uuid" entry is provided
            alongside a
            top-level <a href="#elementsMetadata"><code>uuid</code>
            element</a>, the two values must match.
          </dd>
        </dl>
      </dd>
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
268 269 
    <h3><a name="elementsResources">Basic resources</a></h3>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
270 271 272 273 274 275 276 
<pre>
  ...
  &lt;memory&gt;524288&lt;/memory&gt;
  &lt;currentMemory&gt;524288&lt;/currentMemory&gt;
  &lt;memoryBacking&gt;
    &lt;hugepages/&gt;
  &lt;/memoryBacking&gt;
N
Update docs for memory parameters and memtune command  
Nikunj A. Dadhania 已提交
277 278 279 280 281 282 
  &lt;memtune&gt;
    &lt;hard_limit&gt;1048576&lt;/hard_limit&gt;
    &lt;soft_limit&gt;131072&lt;/soft_limit&gt;
    &lt;swap_hard_limit&gt;2097152&lt;/swap_hard_limit&gt;
    &lt;min_guarantee&gt;65536&lt;/min_guarantee&gt;
  &lt;/memtune&gt;
E
vcpu: add current attribute to <vcpu> element  
Eric Blake 已提交
283 
  &lt;vcpu cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
284 
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
285 286 287 288 

    <dl>
      <dt><code>memory</code></dt>
      <dd>The maximum allocation of memory for the guest at boot time.
M
Cleanup whitespace in docs  
Matthew Booth 已提交
289 
        The units for this value are kilobytes (i.e. blocks of 1024 bytes)</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
290 
      <dt><code>currentMemory</code></dt>
J
docs: fix trivial typos in currentMemory description  
Justin Clift 已提交
291 
      <dd>The actual allocation of memory for the guest. This value can
M
Cleanup whitespace in docs  
Matthew Booth 已提交
292 293 
        be less than the maximum allocation, to allow for ballooning
        up the guests memory on the fly. If this is omitted, it defaults
J
docs: fix trivial typos in currentMemory description  
Justin Clift 已提交
294 
        to the same value as the <code>memory</code> element</dd>
D
Support configuration of huge pages in guests  
Daniel P. Berrange 已提交
295 296 
      <dt><code>memoryBacking</code></dt>
      <dd>The optional <code>memoryBacking</code> element, may have an
M
Cleanup whitespace in docs  
Matthew Booth 已提交
297 298 299 
        <code>hugepages</code> element set within it. This tells the
        hypervisor that the guest should have its memory allocated using
        hugepages instead of the normal native page size.</dd>
N
Update docs for memory parameters and memtune command  
Nikunj A. Dadhania 已提交
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 
      <dt><code>memtune</code></dt>
      <dd> The optional <code>memtune</code> element provides details
      regarding the memory tuneable parameters for the domain. If this is
      omitted, it defaults to the OS provided defaults.</dd>
      <dt><code>hard_limit</code></dt>
      <dd> The optional <code>hard_limit</code> element is the maximum memory
	the guest can use. The units for this value are kilobytes (i.e. blocks
	of 1024 bytes)</dd>
      <dt><code>soft_limit</code></dt>
      <dd> The optional <code>soft_limit</code> element is the memory limit to
	enforce during memory contention. The units for this value are
	kilobytes (i.e. blocks of 1024 bytes)</dd>
      <dt><code>swap_hard_limit</code></dt>
      <dd> The optional <code>swap_hard_limit</code> element is the maximum
	swap the guest can use. The units for this value are kilobytes
	(i.e. blocks of 1024 bytes)</dd>
      <dt><code>min_guarantee</code></dt>
      <dd> The optional <code>min_guarantee</code> element is the guaranteed
	minimum memory allocation for the guest. The units for this value are
	kilobytes (i.e. blocks of 1024 bytes)</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
320 
      <dt><code>vcpu</code></dt>
E
vcpu: add current attribute to <vcpu> element  
Eric Blake 已提交
321 
      <dd>The content of this element defines the maximum number of virtual
E
vcpu: improve cpuset attribute  
Eric Blake 已提交
322 323 324 325 326 327 328 
        CPUs allocated for the guest OS, which must be between 1 and
        the maximum supported by the hypervisor.  <span class="since">Since
        0.4.4</span>, this element can contain an optional
        <code>cpuset</code> attribute, which is a comma-separated
        list of physical CPU numbers that virtual CPUs can be pinned
        to.  Each element in that list is either a single CPU number,
        a range of CPU numbers, or a caret followed by a CPU number to
E
vcpu: add current attribute to <vcpu> element  
Eric Blake 已提交
329 330 331 332 
        be excluded from a previous range.  <span class="since">Since
        0.8.5</span>, the optional attribute <code>current</code> can
        be used to specify whether fewer than the maximum number of
        virtual CPUs should be enabled.
E
vcpu: improve cpuset attribute  
Eric Blake 已提交
333 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
334 335 
    </dl>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
336 337 338 339 340 341 342 343 
    <h3><a name="elementsCPU">CPU model and topology</a></h3>

    <p>
      Requirements for CPU model, its features and topology can be specified
      using the following collection of elements.
      <span class="since">Since 0.7.5</span>
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
344 345 346 347 
<pre>
  ...
  &lt;cpu match='exact'&gt;
    &lt;model&gt;core2duo&lt;/model&gt;
J
cpu: Add support for CPU vendor  
Jiri Denemark 已提交
348 
    &lt;vendor&gt;Intel&lt;/vendor&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
349 350 351 352 
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
    &lt;feature policy='disable' name='lahf_lm'/&gt;
  &lt;/cpu&gt;
  ...</pre>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
353 354 355 356 357 358 359 

    <p>
      In case no restrictions need to be put on CPU model and its features, a
      simpler <code>cpu</code> element can be used.
      <span class="since">Since 0.7.6</span>
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
360 361 362 363 364 365 
<pre>
  ...
  &lt;cpu&gt;
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
  &lt;/cpu&gt;
  ...</pre>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 

    <dl>
      <dt><code>cpu</code></dt>
      <dd>The <code>cpu</code> element is the main container for describing
        guest CPU requirements. Its <code>match</code> attribute specified how
        strictly has the virtual CPU provided to the guest match these
        requirements. <span class="since">Since 0.7.6</span> the
        <code>match</code> attribute can be omitted if <code>topology</code>
        is the only element within <code>cpu</code>. Possible values for the
        <code>match</code> attribute are:

        <dl>
          <dt><code>minimum</code></dt>
          <dd>The specified CPU model and features describes the minimum
            requested CPU.</dd>
          <dt><code>exact</code></dt>
          <dd>The virtual CPU provided to the guest will exactly match the
            specification</dd>
          <dt><code>strict</code></dt>
          <dd>The guest will not be created unless the host CPU does exactly
            match the specification.</dd>
        </dl>
D
Set sensible defaults for cpu match and feature policy  
Daniel P. Berrange 已提交
388 389 390 

	<span class="since">Since 0.8.5</span> the <code>match</code>
	attribute can be omitted and will default to <code>exact</code>.
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
391 392 393 394 395 396 397 398 
      </dd>

      <dt><code>model</code></dt>
      <dd>The content of the <code>model</code> element specifies CPU model
        requested by the guest. The list of available CPU models and their
        definition can be found in <code>cpu_map.xml</code> file installed
        in libvirt's data directory.</dd>
J
cpu: Add support for CPU vendor  
Jiri Denemark 已提交
399 400 401 402 403 404 405 
      <dt><code>vendor</code></dt>
      <dd><span class="since">Since 0.8.3</span> the content of the
        <code>vendor</code> element specifies CPU vendor requested by the
        guest. If this element is missing, the guest can be run on a CPU
        matching given features regardless on its vendor. The list of
        supported vendors can be found in <code>cpu_map.xml</code>.</dd>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 
      <dt><code>topology</code></dt>
      <dd>The <code>topology</code> element specifies requested topology of
        virtual CPU provided to the guest. Three non-zero values have to be
        given for <code>sockets</code>, <code>cores</code>, and
        <code>threads</code>: total number of CPU sockets, number of cores per
        socket, and number of threads per core, respectively.</dd>

      <dt><code>feature</code></dt>
      <dd>The <code>cpu</code> element can contain zero or more
        <code>elements</code> used to fine-tune features provided by the
        selected CPU model. The list of known feature names can be found in
        the same file as CPU models. The meaning of each <code>feature</code>
        element depends on its <code>policy</code> attribute, which has to be
        set to one of the following values:

        <dl>
          <dt><code>force</code></dt>
          <dd>The virtual CPU will claim the feature is supported regardless
            of it being supported by host CPU.</dd>
          <dt><code>require</code></dt>
          <dd>Guest creation will fail unless the feature is supported by host
            CPU.</dd>
          <dt><code>optional</code></dt>
          <dd>The feature will be supported by virtual CPU if and only if it
            is supported by host CPU.</dd>
          <dt><code>disable</code></dt>
          <dd>The feature will not be supported by virtual CPU.</dd>
          <dt><code>forbid</code></dt>
          <dd>Guest creation will fail if the feature is supported by host
            CPU.</dd>
        </dl>
D
Set sensible defaults for cpu match and feature policy  
Daniel P. Berrange 已提交
437 438 439 

	<span class="since">Since 0.8.5</span> the <code>policy</code>
	attribute can be omitted and will default to <code>require</code>.
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
440 441 442 
      </dd>
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
443 444 445 
    <h3><a name="elementsLifecycle">Lifecycle control</a></h3>

    <p>
A
fix typos in docs  
Atsushi SAKAI 已提交
446 
      It is sometimes necessary to override the default actions taken
D
Update domain XML docs  
Daniel P. Berrange 已提交
447 448 449 450 451 452 453 
      when a guest OS triggers a lifecycle operation. The following
      collections of elements allow the actions to be specified. A
      common use case is to force a reboot to be treated as a poweroff
      when doing the initial OS installation. This allows the VM to be
      re-configured for the first post-install bootup.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
454 455 456 457 458 459 
<pre>
  ...
  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
  &lt;on_crash&gt;restart&lt;/on_crash&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
460 461 462 463 

    <dl>
      <dt><code>on_poweroff</code></dt>
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
464 
        the guest requests a poweroff.</dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
465 
      <dt><code>on_reboot</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
466 
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
467 
        the guest requests a reboot.</dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
468 
      <dt><code>on_crash</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
469 
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
470 
        the guest crashes.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
471 472 473 474 475 476 477 478 479 
    </dl>

    <p>
      Each of these states allow for the same four possible actions.
    </p>

    <dl>
      <dt><code>destroy</code></dt>
      <dd>The domain will be terminated completely and all resources
M
Cleanup whitespace in docs  
Matthew Booth 已提交
480 
        released</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
481 482 
      <dt><code>restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
M
Cleanup whitespace in docs  
Matthew Booth 已提交
483 
        the same configuration</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
484 485 
      <dt><code>preserve</code></dt>
      <dd>The domain will be terminated, and its resource preserved
M
Cleanup whitespace in docs  
Matthew Booth 已提交
486 
        to allow analysis.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
487 488 
      <dt><code>rename-restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
M
Cleanup whitespace in docs  
Matthew Booth 已提交
489 
        a new name</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
490 491 
    </dl>
J
Add actions to virDomainLifecycle enum  
Jim Fehlig 已提交
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 
    <p>
      on_crash supports these additional
      actions <span class="since">since 0.8.4</span>.
    </p>

    <dl>
      <dt><code>coredump-destroy</code></dt>
      <dd>The crashed domain's core will be dumped, and then the
        domain will be terminated completely and all resources
        released</dd>
      <dt><code>coredump-restart</code></dt>
      <dd>The crashed domain's core will be dumped, and then the
        domain will be restarted with the same configuration</dd>
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
507 508 509 510 511 512 513 
    <h3><a name="elementsFeatures">Hypervisor features</a></h3>

    <p>
      Hypervisors may allow certain CPU / machine features to be
      toggled on/off.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
514 515 516 517 518 519 
<pre>
  ...
  &lt;features&gt;
    &lt;pae/&gt;
    &lt;acpi/&gt;
    &lt;apic/&gt;
J
Document HAP domain feature  
Jim Fehlig 已提交
520 
    &lt;hap/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
521 522 
  &lt;/features&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
523 524 525 526 527 528 529 530 531 532 533 534 

    <p>
      All features are listed within the <code>features</code>
      element, omitting a togglable feature tag turns it off.
      The available features can be found by asking
      for the <a href="formatcaps.html">capabilities XML</a>,
      but a common set for fully virtualized domains are:
    </p>

    <dl>
      <dt><code>pae</code></dt>
      <dd>Physical address extension mode allows 32-bit guests
M
Cleanup whitespace in docs  
Matthew Booth 已提交
535 
        to address more than 4 GB of memory.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
536 537 
      <dt><code>acpi</code></dt>
      <dd>ACPI is useful for power management, for example, with
M
Cleanup whitespace in docs  
Matthew Booth 已提交
538 
        KVM guests it is required for graceful shutdown to work.
D
Update domain XML docs  
Daniel P. Berrange 已提交
539 
      </dd>
J
Document HAP domain feature  
Jim Fehlig 已提交
540 541 542 543 
      <dt><code>hap</code></dt>
      <dd>Enable use of Hardware Assisted Paging if available in
        the hardware.
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
544 545 546 547 548 549 550 551 552 553 554 
    </dl>

    <h3><a name="elementsTime">Time keeping</a></h3>

    <p>
      The guest clock is typically initialized from the host clock.
      Most operating systems expect the hardware clock to be kept
      in UTC, and this is the default. Windows, however, expects
      it to be in so called 'localtime'.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
555 556 
<pre>
  ...
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
557 558 559 560 561 562 
  &lt;clock offset="localtime"&gt;
    &lt;timer name="rtc" tickpolicy="catchup" track="guest"&gt;
      &lt;catchup threshold=123 slew=120 limit=10000/&gt;
    &lt;/timer&gt;
    &lt;timer name="pit" tickpolicy="none"/&gt;
  &lt;/clock&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
563 
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
564 565 566 

    <dl>
      <dt><code>clock</code></dt>
D
Expand docs about clock modes  
Daniel P. Berrange 已提交
567 
      <dd>
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
568 
	<p>The <code>offset</code> attribute takes four possible
D
Expand docs about clock modes  
Daniel P. Berrange 已提交
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 
	  values, allowing fine grained control over how the guest
	  clock is synchronized to the host. NB, not all hypervisors
	  support all modes.</p>
	<dl>
	  <dt><code>utc</code></dt>
	  <dd>
	    The guest clock will always be synchronized to UTC when
	    booted</dd>
	  <dt><code>localtime</code></dt>
	  <dd>
	    The guest clock will be synchronized to the host's configured
	    timezone when booted, if any.
	  </dd>
	  <dt><code>timezone</code></dt>
	  <dd>
	    The guest clock will be synchronized to the requested timezone
	    using the <code>timezone</code> attribute.
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
586 
	    <span class="since">Since 0.7.7</span>
D
Expand docs about clock modes  
Daniel P. Berrange 已提交
587 588 589 590 591 592 593 594 595 
	  </dd>
	  <dt><code>variable</code></dt>
	  <dd>
	    The guest clock will have an arbitrary offset applied
	    relative to UTC. The delta relative to UTC is specified
	    in seconds, using the <code>adjustment</code> attribute.
	    The guest is free to adjust the RTC over time an expect
	    that it will be honoured at next reboot. This is in
	    contrast to 'utc' mode, where the RTC adjustments are
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
596 
	    lost at each reboot. <span class="since">Since 0.7.7</span>
D
Expand docs about clock modes  
Daniel P. Berrange 已提交
597 598 599 
	  </dd>
	</dl>
	<p>
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
600 601 602 
	  A <code>clock</code> may have zero or more
	  <code>timer</code>sub-elements. <span class="since">Since
	  0.8.0</span>
D
Expand docs about clock modes  
Daniel P. Berrange 已提交
603 
	</p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
604 
      </dd>
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 
      <dt><code>timer</code></dt>
      <dd>
	<p>
	  Each timer element requires a <code>name</code> attribute,
	  and has other optional attributes that depend on
	  the <code>name</code> specified.  Various hypervisors
	  support different combinations of attributes.
	</p>
	<dl>
	  <dt><code>name</code></dt>
	  <dd>
	    The <code>name</code> attribute selects which timer is
	    being modified, and can be one of "platform", "pit",
	    "rtc", "hpet", or "tsc".
	  </dd>
	  <dt><code>track</code></dt>
	  <dd>
	    The <code>track</code> attribute specifies what the timer
	    tracks, and can be "boot", "guest", or "wall".
	    Only valid for <code>name="rtc"</code>
	    or <code>name="platform"</code>.
	  </dd>
	  <dt><code>tickpolicy</code></dt>
	  <dd>
	    The <code>tickpolicy</code> attribute determines how
	    missed ticks in the guest are handled, and can be "delay",
	    "catchup", "merge", or "discard".  If the policy is
	    "catchup", there can be further details in
	    the <code>catchup</code> sub-element.
	    <dl>
	      <dt><code>catchup</code></dt>
	      <dd>
		The <code>catchup</code> element has three optional
		attributes, each a positive integer.  The attributes
		are <code>threshold</code>, <code>slew</code>,
		and <code>limit</code>.
	      </dd>
	    </dl>
	  </dd>
	  <dt><code>frequency</code></dt>
	  <dd>
	    The <code>frequency</code> attribute is an unsigned
	    integer specifying the frequency at
	    which <code>name="tsc"</code> runs.
	  </dd>
	  <dt><code>mode</code></dt>
	  <dd>
	    The <code>mode</code> attribute controls how
	    the <code>name="tsc"</code> timer is managed, and can be
	    "auto", "native", "emulate", "paravirt", or "smpsafe".
	    Other timers are always emulated.
	  </dd>
	  <dt><code>present</code></dt>
	  <dd>
	    The <code>present</code> attribute can be "yes" or "no" to
	    specify whether a particular timer is available to the guest.
	  </dd>
	</dl>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
664 665 666 667 668 
    </dl>

    <h3><a name="elementsDevices">Devices</a></h3>

    <p>
A
fix typos in docs  
Atsushi SAKAI 已提交
669 
      The final set of XML elements are all used to describe devices
D
Update domain XML docs  
Daniel P. Berrange 已提交
670 671 672 673 674 
      provided to the guest domain. All devices occur as children
      of the main <code>devices</code> element.
      <span class="since">Since 0.1.3</span>
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
675 676 677 678 679 680 
<pre>
  ...
  &lt;devices&gt;
    &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
681 682 683 684 

    <dl>
      <dt><code>emulator</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
685 686 687 688 689 
        The contents of the <code>emulator</code> element specify
        the fully qualified path to the device model emulator binary.
        The <a href="formatcaps.html">capabilities XML</a> specifies
        the recommended default emulator to use for each particular
        domain type / architecture combination.
D
Update domain XML docs  
Daniel P. Berrange 已提交
690 691 692 693 694 695 696 697 698 699 700 
      </dd>
    </dl>

    <h4><a name="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4>

    <p>
      Any device that looks like a disk, be it a floppy, harddisk,
      cdrom, or paravirtualized driver is specified via the <code>disk</code>
      element.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
701 702 703 704 
<pre>
  ...
  &lt;devices&gt;
    &lt;disk type='file'&gt;
М
Add docs on drive <serial> element  
Марк Коренберг 已提交
705 
      &lt;driver name="tap" type="aio" cache="default"/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
706 707 
      &lt;source file='/var/lib/xen/images/fv0'/&gt;
      &lt;target dev='hda' bus='ide'/&gt;
J
Introduce per-device boot element  
Jiri Denemark 已提交
708 
      &lt;boot order='2'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
709 710 711 712 
      &lt;encryption type='...'&gt;
        ...
      &lt;/encryption&gt;
      &lt;shareable/&gt;
М
Add docs on drive <serial> element  
Марк Коренберг 已提交
713 714 715 
      &lt;serial&gt;
        ...
      &lt;/serial&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
716 
    &lt;/disk&gt;
M
update docs for network disks  
MORITA Kazutaka 已提交
717 718 719 720 721 722 723 
      ...
    &lt;disk type='network'&gt;
      &lt;driver name="qemu" type="raw"/&gt;
      &lt;source protocol="sheepdog" name="image_name"&gt;
        &lt;host name="hostname" port="7000"/&gt;
      &lt;/source&gt;
      &lt;target dev="hdb" bus="ide"/&gt;
J
Introduce per-device boot element  
Jiri Denemark 已提交
724 
      &lt;boot order='1'/&gt;
M
update docs for network disks  
MORITA Kazutaka 已提交
725 
    &lt;/disk&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
726 727 
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
728 729 730 731 

    <dl>
      <dt><code>disk</code></dt>
      <dd>The <code>disk</code> element is the main container for describing
M
update docs for network disks  
MORITA Kazutaka 已提交
732 733 
        disks. The <code>type</code> attribute is either "file",
        "block", "dir", or "network"
M
Cleanup whitespace in docs  
Matthew Booth 已提交
734 735 736 737 
        and refers to the underlying source for the disk. The optional
        <code>device</code> attribute indicates how the disk is to be exposed
        to the guest OS. Possible values for this attribute are "floppy", "disk"
        and "cdrom", defaulting to "disk".
M
update docs for network disks  
MORITA Kazutaka 已提交
738 739 
        <span class="since">Since 0.0.3; "device" attribute since 0.1.4;
        "network" attribute since 0.8.7</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
740 
      <dt><code>source</code></dt>
M
update docs for network disks  
MORITA Kazutaka 已提交
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 
      <dd>If the disk <code>type</code> is "file", then the
        the <code>file</code> attribute specifies the fully-qualified
        path to the file holding the disk. If the disk
        <code>type</code> is "block", then the <code>dev</code>
        attribute specifies the path to the host device to serve as
        the disk. If the disk <code>type</code> is "network", then
        the <code>protocol</code> attribute specifies the protocol to
        access to the requested image; possible values are "nbd",
        "rbd", and "sheepdog".  If the <code>protocol</code> attribute
        is "rbd" or "sheepdog", an additional
        attribute <code>name</code> is mandatory to specify which
        image to be used.  When the disk <code>type</code> is
        "network", the <code>source</code> may have zero or
        more <code>host</code> sub-elements used to specify the hosts
        to connect.
        <span class="since">Since 0.0.3</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
757 758 
      <dt><code>target</code></dt>
      <dd>The <code>target</code> element controls the bus / device under which the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
759 760 761 762 763 764 765 766 767 
        disk is exposed to the guest OS. The <code>dev</code> attribute indicates
        the "logical" device name. The actual device name specified is not guaranteed to map to
        the device name in the guest OS. Treat it as a device ordering hint.
        The optional <code>bus</code> attribute specifies the type of disk device
        to emulate; possible values are driver specific, with typical values being
        "ide", "scsi", "virtio", "xen" or "usb". If omitted, the bus type is
        inferred from the style of the device name. eg, a device named 'sda'
        will typically be exported using a SCSI bus.
        <span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
D
documentation for USB passthrough  
Daniel Veillard 已提交
768 
        "usb" attribute value since after 0.4.4</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
769 770 
      <dt><code>driver</code></dt>
      <dd>If the hypervisor supports multiple backend drivers, then the optional
M
Cleanup whitespace in docs  
Matthew Booth 已提交
771 772 
        <code>driver</code> element allows them to be selected. The <code>name</code>
        attribute is the primary backend driver name, while the optional <code>type</code>
M
Document the domain XML cache attribute for disk devices  
Matthias Bolte 已提交
773 774 775 
        attribute provides the sub-type. The optional <code>cache</code> attribute
        controls the cache mechanism, possible values are "default", "none",
        "writethrough" and "writeback". <span class="since">Since 0.1.8</span>
D
Update domain XML docs  
Daniel P. Berrange 已提交
776 
      </dd>
J
Introduce per-device boot element  
Jiri Denemark 已提交
777 778 779 780 781 782 783 784 
      <dt><code>boot</code></dt>
      <dd>Specifies that the disk is bootable. The <code>order</code>
        attribute determines the order in which devices will be tried during
        boot sequence. The per-device <code>boot</code> elements cannot be
        used together with general boot elements in
        <a href="#elementsOSBIOS">BIOS bootloader</a> section.
        <span class="since">Since 0.8.8</span>
      </dd>
M
Attach encryption information to virDomainDiskDef.  
Miloslav Trmač 已提交
785 786 787 788 789 
      <dt><code>encryption</code></dt>
      <dd>If present, specifies how the volume is encrypted.  See
        the <a href="formatstorageencryption.html">Storage Encryption</a> page
        for more information.
      </dd>
D
add missing doc for device <shareable/> option  
Daniel Veillard 已提交
790 791 792 793 794 
      <dt><code>shareable</code></dt>
      <dd>If present, this indicates the device is expected to be shared
          between domains (assuming the hypervisor and OS support this),
          which means that caching should be deactivated for that device.
      </dd>
М
Add docs on drive <serial> element  
Марк Коренберг 已提交
795 796 797 798 799 
      <dt><code>serial</code></dt>
      <dd>If present, this specify serial number of virtual hard drive.
          For example, it may look as <code>&lt;serial&gt;WD-WMAP9A966149&lt;/serial&gt;</code>.
          <span class="since">Since 0.7.1</span>
      </dd>
M
update docs for network disks  
MORITA Kazutaka 已提交
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 
      <dt><code>host</code></dt>
      <dd>The <code>host</code> element has two attributes "name" and "port",
        which specify the hostname and the port number. The meaning of this
        element and the number of the elements depend on the protocol attribute.
        <table class="top_table">
          <tr>
            <th> Protocol </th>
            <th> Meaning </th>
            <th> Number of hosts </th>
          </tr>
          <tr>
            <td> nbd </td>
            <td> a server running nbd-server </td>
            <td> only one </td>
          </tr>
          <tr>
            <td> rbd </td>
            <td> monitor servers of RBD </td>
            <td> one or more </td>
          </tr>
          <tr>
            <td> sheepdog </td>
            <td> one of the sheepdog servers (default is localhost:7000) </td>
            <td> zero or one </td>
          </tr>
        </table>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
827 828 
    </dl>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
829 
    <h4><a name="elementsUSB">USB and PCI devices</a></h4>
D
documentation for USB passthrough  
Daniel Veillard 已提交
830 831 

    <p>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
832 833 834 
      USB and PCI devices attached to the host can be passed through to the guest using
      the <code>hostdev</code> element. <span class="since">since after
      0.4.4 for USB and 0.6.0 for PCI (KVM only)</span>:
D
documentation for USB passthrough  
Daniel Veillard 已提交
835 836 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
837 838 839 840 841 842 843 844 845 846 847 848 
<pre>
  ...
  &lt;devices&gt;
    &lt;hostdev mode='subsystem' type='usb'&gt;
      &lt;source&gt;
        &lt;vendor id='0x1234'/&gt;
        &lt;product id='0xbeef'/&gt;
      &lt;/source&gt;
    &lt;/hostdev&gt;
  &lt;/devices&gt;
  ...</pre>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
849 
    <p>or:</p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
850 851 852 853 854 855 856 857 858 859 860 

<pre>
  ...
  &lt;devices&gt;
    &lt;hostdev mode='subsystem' type='pci'&gt;
      &lt;source&gt;
        &lt;address bus='0x06' slot='0x02' function='0x0'/&gt;
      &lt;/source&gt;
    &lt;/hostdev&gt;
  &lt;/devices&gt;
  ...</pre>
D
documentation for USB passthrough  
Daniel Veillard 已提交
861 862 863 864 865 

    <dl>
      <dt><code>hostdev</code></dt>
      <dd>The <code>hostdev</code> element is the main container for describing
      host devices. For usb device passthrough <code>mode</code> is always
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
866 867 
      "subsystem" and <code>type</code> is "usb" for an USB device and "pci"
      for a PCI device..
D
documentation for USB passthrough  
Daniel Veillard 已提交
868 869 870 871 
      <dt><code>source</code></dt>
      <dd>The source element describes the device as seen from the host.
      The USB device can either be addressed by vendor / product id using the
      <code>vendor</code> and <code>product</code> elements or by the device's
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
872 873 874 
      address on the hosts using the <code>address</code> element.
      PCI devices on the other hand can only be described by their
      <code>address</code></dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
875 876 877 878 879 880 
      <dt><code>vendor</code>, <code>product</code></dt>
      <dd>The <code>vendor</code> and <code>product</code> elements each have an
      <code>id</code> attribute that specifies the USB vendor and product id.
      The ids can be given in decimal, hexadecimal (starting with 0x) or
      octal (starting with 0) form.</dd>
      <dt><code>address</code></dt>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
881 882 883 884 885 886 887 888 889 890 891 892 893 894 
      <dd>The <code>address</code> element for USB devices has a
      <code>bus</code> and <code>device</code> attribute to specify the
      USB bus and device number the device appears at on the host.
      The values of these attributes can be given in decimal, hexadecimal
      (starting with 0x) or octal (starting with 0) form.
      For PCI devices the element carries 3 attributes allowing to designate
      the device as can be found with the <code>lspci</code> or
      with <code>virsh nodedev-list</code>. The
      <code>bus</code> attribute allows the hexadecimal values 0 to ff, the
      <code>slot</code> attribute allows the hexadecimal values 0 to 1f, and
      the <code>function</code> attribute allows the hexadecimal values 0 to
      7. There is also an optional <code>domain</code> attribute for the
      PCI domain, with hexadecimal values 0 to ffff, but it is currently
      not used by qemu.</dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
895 896 
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
897 898 
    <h4><a name="elementsNICS">Network interfaces</a></h4>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
899 900 901 902 903 904 905 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='bridge'&gt;
      &lt;source bridge='xenbr0'/&gt;
      &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
      &lt;script path='vif-bridge'/&gt;
J
Introduce per-device boot element  
Jiri Denemark 已提交
906 
      &lt;boot order='1'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
907 908 909 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 

    <h5><a name="elementsNICSVirtual">Virtual network</a></h5>

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
      hosts with dynamic / wireless networking configs
      </em></strong>
    </p>

    <p>
      Provides a virtual network using a bridge device in the host.
      Depending on the virtual network configuration, the network may be
      totally isolated, NAT'ing to an explicit network device, or NAT'ing to
      the default route. DHCP and DNS are provided on the virtual network in
      all cases and the IP range can be determined by examining the virtual
      network config with '<code>virsh net-dumpxml [networkname]</code>'.
      There is one virtual network called 'default' setup out
      of the box which does NAT'ing to the default route and has an IP range of
      <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
      associated tun device created with a name of vnetN, which can also be
C
Document overriding domain interface target  
Cole Robinson 已提交
931 932 
      overridden with the &lt;target&gt; element (see
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
D
Update domain XML docs  
Daniel P. Berrange 已提交
933 934 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
935 936 937 938 939 940 941 942 943 944 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
    &lt;/interface&gt;
    ...
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet7'/&gt;
R
Avoid using multicast addresses for Ethernet MAC examples  
redshift 已提交
945 
      &lt;mac address="00:11:22:33:44:55"/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
946 947 948 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
949
D
Fix a number of small typos  
Dan Kenigsberg 已提交
950 
    <h5><a name="elementsNICSBridge">Bridge to LAN</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
951 952 953 954 955 956 957 958 959 960 961 962 963 

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
      hosts with static wired networking configs
      </em></strong>
    </p>

    <p>
      Provides a bridge from the VM directly onto the LAN. This assumes
      there is a bridge device on the host which has one or more of the hosts
      physical NICs enslaved. The guest VM will have an associated tun device
      created with a name of vnetN, which can also be overridden with the
C
Document overriding domain interface target  
Cole Robinson 已提交
964 965 966 967 968 
      &lt;target&gt; element (see
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
      The tun device will be enslaved to the bridge. The IP range / network
      configuration is whatever is used on the LAN. This provides the guest VM
      full incoming &amp; outgoing net access just like a physical machine.
D
Update domain XML docs  
Daniel P. Berrange 已提交
969 970 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
971 972 973 974 975 976 977 978 979 980 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='bridge'&gt;
      &lt;source bridge='br0'/&gt;
    &lt;/interface&gt;
    ...
    &lt;interface type='bridge'&gt;
      &lt;source bridge='br0'/&gt;
      &lt;target dev='vnet7'/&gt;
R
Avoid using multicast addresses for Ethernet MAC examples  
redshift 已提交
981 
      &lt;mac address="00:11:22:33:44:55"/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
982 983 984 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
985 986 987 988 989 990 991 992 993 994 995 996 

    <h5><a name="elementsNICSSlirp">Userspace SLIRP stack</a></h5>

    <p>
      Provides a virtual LAN with NAT to the outside world. The virtual
      network has DHCP &amp; DNS services and will give the guest VM addresses
      starting from <code>10.0.2.15</code>. The default router will be
      <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
      This networking is the only option for unprivileged users who need their
      VMs to have outgoing access.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
997 998 999 1000 1001 1002 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='user'/&gt;
    ...
    &lt;interface type='user'&gt;
R
Avoid using multicast addresses for Ethernet MAC examples  
redshift 已提交
1003 
      &lt;mac address="00:11:22:33:44:55"/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1004 1005 1006 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 


    <h5><a name="elementsNICSEthernet">Generic ethernet connection</a></h5>

    <p>
      Provides a means for the administrator to execute an arbitrary script
      to connect the guest's network to the LAN. The guest will have a tun
      device created with a name of vnetN, which can also be overridden with the
      &lt;target&gt; element. After creating the tun device a shell script will
      be run which is expected to do whatever host network integration is
      required. By default this script is called /etc/qemu-ifup but can be
      overridden.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='ethernet'/&gt;
    ...
    &lt;interface type='ethernet'&gt;
      &lt;target dev='vnet7'/&gt;
      &lt;script path='/etc/qemu-ifup-mynet'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1032
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
1033 1034 1035 1036 
    <h5><a name="elementsNICSDirect">Direct attachment to physical interface</a></h5>

    <p>
      Provides direct attachment of the virtual machine's NIC to the given
S
Mention direct device support since 0.7.7 in docs  
Stefan Berger 已提交
1037 1038 1039 1040 1041 
      physial interface of the host.
      <span class="since">Since 0.7.7 (QEMU and KVM only)</span><br>
      This setup requires the Linux macvtap
      driver to be available. <span class="since">(Since Linux 2.6.34.)</span>
      One of the modes 'vepa'
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
1042 1043 
      ( <a href="http://www.ieee802.org/1/files/public/docs2009/new-evb-congdon-vepa-modular-0709-v01.pdf">
      'Virtual  Ethernet Port Aggregator'</a>), 'bridge' or 'private'
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
1044 
      can be chosen for the operation mode of the macvtap device, 'vepa'
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
1045 1046 
      being the default mode. The individual modes cause the delivery of
      packets to behave as follows:
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
1047 1048 
    </p>
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 
    <dl>
      <dt><code>vepa</code></dt>
      <dd>All VMs' packets are sent to the external bridge. Packets
      whose destination is a VM on the same host as where the
      packet originates from are sent back to the host by the VEPA
      capable bridge (today's bridges are typically not VEPA capable).</dd>
      <dt><code>bridge</code></dt>
      <dd>Packets whose destination is on the same host as where they
      originate from are directly delivered to the target macvtap device.
      Both origin and destination devices need to be in bridge mode
      for direct delivery. If either one of them is in <code>vepa</code> mode,
      a VEPA capable bridge is required.
      <dt><code>private</code></dt>
      <dd>All packets are sent to the external bridge and will only be
      delivered to a target VM on the same host if they are sent through an
      external router or gateway and that device sends them back to the
      host. This procedure is followed if either the source or destination
      device is in <code>private</code> mode.</dd>
    </dl>
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='direct'/&gt;
    ...
    &lt;interface type='direct'&gt;
      &lt;source dev='eth0' mode='vepa'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 
    <h5><a name="elementsNICSMulticast">Multicast tunnel</a></h5>

    <p>
      A multicast group is setup to represent a virtual network. Any VMs
      whose network devices are in the same multicast group can talk to each
      other even across hosts. This mode is also available to unprivileged
      users. There is no default DNS or DHCP support and no outgoing network
      access. To provide outgoing network access, one of the VMs should have a
      2nd NIC which is connected to one of the first 4 network types and do the
      appropriate routing. The multicast protocol is compatible with that used
      by user mode linux guests too. The source address used must be from the
      multicast address block.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1095 1096 1097 1098 1099 1100 1101 1102 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='mcast'&gt;
      &lt;source address='230.0.0.1' port='5558'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 

    <h5><a name="elementsNICSTCP">TCP tunnel</a></h5>

    <p>
      A TCP client/server architecture provides a virtual network. One VM
      provides the server end of the network, all other VMS are configured as
      clients. All network traffic is routed between the VMs via the server.
      This mode is also available to unprivileged users. There is no default
      DNS or DHCP support and no outgoing network access. To provide outgoing
      network access, one of the VMs should have a 2nd NIC which is connected
      to one of the first 4 network types and do the appropriate routing.</p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1115 1116 1117 1118 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='server'&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
1119 
      &lt;source address='192.168.0.1' port='5558'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1120 1121 1122 1123 1124 1125 1126 
    &lt;/interface&gt;
    ...
    &lt;interface type='client'&gt;
    &lt;source address='192.168.0.1' port='5558'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1127
R
Documentation for NIC model selection.  
Richard W.M. Jones 已提交
1128 1129 
    <h5><a name="elementsNICSModel">Setting the NIC model</a></h5>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
      <b>&lt;model type='ne2k_pci'/&gt;</b>
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
R
Documentation for NIC model selection.  
Richard W.M. Jones 已提交
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 

    <p>
      For hypervisors which support this, you can set the model of
      emulated network interface card.
    </p>

    <p>
      The values for <code>type</code> aren't defined specifically by
      libvirt, but by what the underlying hypervisor supports (if
      any).  For QEMU and KVM you can get a list of supported models
      with these commands:
    </p>

<pre>
qemu -net nic,model=? /dev/null
qemu-kvm -net nic,model=? /dev/null
</pre>

    <p>
      Typical values for QEMU and KVM include:
      ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1162
C
Document overriding domain interface target  
Cole Robinson 已提交
1163 1164 
    <h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1165 1166 1167 1168 1169 1170 1171 1172 1173 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      <b>&lt;target dev='vnet1'/&gt;</b>
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
C
Document overriding domain interface target  
Cole Robinson 已提交
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 

    <p>
        If no target is specified, certain hypervisors will automatically
        generate a name for the created tun device. This name can be manually
        specifed, however the name <i>must not start with either 'vnet' or
        'vif'</i>, which are prefixes reserved by libvirt and certain
        hypervisors. Manually specified targets using these prefixes will be
        ignored.
    </p>
J
Introduce per-device boot element  
Jiri Denemark 已提交
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 
    <h5><a name="elementsNICSBoot">Specifying boot order</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
      <b>&lt;boot order='1'/&gt;</b>
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

    <p>
      For hypervisors which support this, you can set exact NIC which should
      be used for network boot. The <code>order</code> attribute determines
      the order in which devices will be tried during boot sequence. The
      per-device <code>boot</code> elements cannot be used together with
      general boot elements in
      <a href="#elementsOSBIOS">BIOS bootloader</a> section.
      <span class="since">Since 0.8.8</span>
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1207 1208 1209 1210 1211 1212 1213 1214 1215 
    <h4><a name="elementsInput">Input devices</a></h4>

    <p>
      Input devices allow interaction with the graphical framebuffer in the guest
      virtual machine. When enabling the framebuffer, an input device is automatically
      provided. It may be possible to add additional devices explicitly, for example,
      to provide a graphics tablet for absolute cursor movement.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1216 1217 1218 1219 1220 1221 
<pre>
  ...
  &lt;devices&gt;
    &lt;input type='mouse' bus='usb'/&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1222 1223 1224 

    <dl>
      <dt><code>input</code></dt>
A
fix typos in docs  
Atsushi SAKAI 已提交
1225 
      <dd>The <code>input</code> element has one mandatory attribute, the <code>type</code>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1226 1227 1228 1229 
        whose value can be either 'mouse' or 'tablet'. The latter provides absolute
        cursor movement, while the former uses relative movement. The optional
        <code>bus</code> attribute can be used to refine the exact device type.
        It takes values "xen" (paravirtualized), "ps2" and "usb".</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 
    </dl>


    <h4><a name="elementsGraphics">Graphical framebuffers</a></h4>

    <p>
      A graphics device allows for graphical interaction with the
      guest OS. A guest will typically have either a framebuffer
      or a text console configured to allow interaction with the
      admin.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1242 1243 1244 1245 1246 1247 1248 1249 1250 
<pre>
  ...
  &lt;devices&gt;
    &lt;graphics type='sdl' display=':0.0'/&gt;
    &lt;graphics type='vnc' port='5904'/&gt;
    &lt;graphics type='rdp' autoport='yes' multiUser='yes' /&gt;
    &lt;graphics type='desktop' fullscreen='yes'/&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1251 1252 1253 1254 

    <dl>
      <dt><code>graphics</code></dt>
      <dd>The <code>graphics</code> element has a mandatory <code>type</code>
F
add doc for graphic and video elements  
Florian Vichot 已提交
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 
  attribute which takes the value "sdl", "vnc", "rdp" or "desktop":
        <dl>
          <dt><code>"sdl"</code></dt>
          <dd>
  This displays a window on the host desktop, it can take 3 optional arguments:
  a <code>display</code> attribute for the display to use, an <code>xauth</code>
  attribute for the authentication identifier, and an optional <code>fullscreen</code>
  attribute accepting values 'yes' or 'no'.
          </dd>
          <dt><code>"vnc"</code></dt>
          <dd>
  Starts a VNC server. The <code>port</code> attribute specifies the TCP
  port number (with -1 as legacy syntax indicating that it should be
  auto-allocated). The <code>autoport</code> attribute is the new
  preferred syntax for indicating autoallocation of the TCP port to use.
  The <code>listen</code> attribute is an IP address for the server to
  listen on. The <code>passwd</code> attribute provides a VNC password
  in clear text. The <code>keymap</code> attribute specifies the keymap
D
Define XML syntax for password expiry  
Daniel P. Berrange 已提交
1273 1274 1275 
  to use. It is possible to set a limit on the validity of the password
  be giving an timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
  assumed to be in UTC. NB, this may not be supported by all hypervisors.
D
Add a <graphics> type for SPICE protocol  
Daniel P. Berrange 已提交
1276 1277 1278 
          </dd>
          <dt><code>"spice"</code></dt>
          <dd>
D
Support SPICE channel security options  
Daniel P. Berrange 已提交
1279 
	    <p>
D
Add a <graphics> type for SPICE protocol  
Daniel P. Berrange 已提交
1280 1281 1282 1283 1284 1285 1286 1287 
  Starts a SPICE server. The <code>port</code> attribute specifies the TCP
  port number (with -1 as legacy syntax indicating that it should be
  auto-allocated), while <code>tlsPort</code> gives an alternative
  secure port number. The <code>autoport</code> attribute is the new
  preferred syntax for indicating autoallocation of both port numbers.
  The <code>listen</code> attribute is an IP address for the server to
  listen on. The <code>passwd</code> attribute provides a SPICE password
  in clear text. The <code>keymap</code> attribute specifies the keymap
D
Define XML syntax for password expiry  
Daniel P. Berrange 已提交
1288 1289 1290 
  to use. It is possible to set a limit on the validity of the password
  be giving an timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
  assumed to be in UTC. NB, this may not be supported by all hypervisors.
D
Support SPICE channel security options  
Daniel P. Berrange 已提交
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 
	    </p>
	    <p>
  When SPICE has both a normal and TLS secured TCP port configured, it
  can be desirable to restrict what channels can be run on each port.
  This is achieved by adding one or more &lt;channel&gt; elements inside
  the main &lt;graphics&gt; element. Valid channel names include
  <code>main</code>,<code>display</code>,<code>inputs</code>,<code>cursor</code>,
  <code>playback</code>,<code>record</code>.
	    </p>
	    <pre>
  &lt;graphics type='spice' port='-1' tlsPort='-1' autoport='yes'&gt;
    &lt;channel name='main' mode='secure'/&gt;
    &lt;channel name='record' mode='insecure'/&gt;
  &lt;/graphics&gt;</pre>
F
add doc for graphic and video elements  
Florian Vichot 已提交
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 
          </dd>
          <dt><code>"rdp"</code></dt>
          <dd>
  Starts a RDP server. The <code>port</code> attribute
  specifies the TCP port number (with -1 as legacy syntax indicating
  that it should be auto-allocated). The <code>autoport</code> attribute
  is the new preferred syntax for indicating autoallocation of the TCP
  port to use. The <code>replaceUser</code> attribute is a boolean deciding
  whether multiple simultaneous connections to the VM are permitted.
  The <code>multiUser</code> whether the existing connection must be dropped
  and a new connection must be established by the VRDP server, when a new
  client connects in single connection mode.

          </dd>
          <dt><code>"desktop"</code></dt>
          <dd>
  This value is reserved for VirtualBox domains for the moment. It displays
  a window on the host desktop, similarly to "sdl", but using the VirtualBox
  viewer. Just like "sdl", it accepts the optional attributes <code>display</code>
  and <code>fullscreen</code>.
          </dd>
        </dl>
      </dd>
    </dl>

    <h4><a name="elementsVideo">Video devices</a></h4>
    <p>
      A video device.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 
<pre>
  ...
  &lt;devices&gt;
    &lt;video&gt;
      &lt;model type='vga' vram='8192' heads='1'&gt;
        &lt;acceleration accel3d='yes' accel3d='yes'/&gt;
      &lt;/model&gt;
    &lt;/video&gt;
  &lt;/devices&gt;
  ...</pre>
F
add doc for graphic and video elements  
Florian Vichot 已提交
1345 1346 1347 

    <dl>
      <dt><code>video</code></dt>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
1348 1349 1350 1351 
      <dd>
        The <code>video</code> element is the a container for describing
        video devices.
      </dd>
F
add doc for graphic and video elements  
Florian Vichot 已提交
1352
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
1353 1354 1355 
      <dt><code>model</code></dt>
      <dd>
        The <code>model</code> element has a mandatory <code>type</code>
D
Add a QXL graphics card type to domain XML schema  
Daniel P. Berrange 已提交
1356 1357 
        attribute which takes the value "vga", "cirrus", "vmvga", "qxl",
	"xen" or "vbox", depending on the hypervisor features available.
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 
        You can also provide the amount of video memory in kilobytes using
        <code>vram</code> and the number of screen with <code>heads</code>.
      </dd>

      <dt><code>acceleration</code></dt>
      <dd>
        If acceleration should be enabled (if supported) using the
        <code>accel3d</code> and <code>accel2d</code> attributes in the
        <code>acceleration</code> element.
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1368 1369 
    </dl>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
1370 
    <h4><a name="elementsConsole">Consoles, serial, parallel &amp; channel devices</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1371 1372 1373 

    <p>
      A character device provides a way to interact with the virtual machine.
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
1374 1375 
      Paravirtualized consoles, serial ports, parallel ports and channels are
      all classed as character devices and so represented using the same syntax.
D
Update domain XML docs  
Daniel P. Berrange 已提交
1376 1377 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 
<pre>
  ...
  &lt;devices&gt;
    &lt;parallel type='pty'&gt;
      &lt;source path='/dev/pts/2'/&gt;
      &lt;target port='0'/&gt;
    &lt;/parallel&gt;
    &lt;serial type='pty'&gt;
      &lt;source path='/dev/pts/3'/&gt;
      &lt;target port='0'/&gt;
    &lt;/serial&gt;
    &lt;console type='pty'&gt;
      &lt;source path='/dev/pts/4'/&gt;
      &lt;target port='0'/&gt;
    &lt;/console&gt;
    &lt;channel type='unix'&gt;
      &lt;source mode='bind' path='/tmp/guestfwd'/&gt;
      &lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
    &lt;/channel&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1399
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1400 1401 1402 1403 1404 
    <p>
      In each of these directives, the top-level element name (parallel, serial,
      console, channel) describes how the device is presented to the guest. The
      guest interface is configured by the <code>target</code> element.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1405
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 
    <p>
      The interface presented to the host is given in the <code>type</code>
      attribute of the top-level element. The host interface is
      configured by the <code>source</code> element.
    </p>

    <h5><a name="elementsCharGuestInterface">Guest interface</a></h5>

    <p>
      A character device presents itself to the guest as one of the following
      types.
    </p>

    <h6><a name="elementCharParallel">Parallel port</a></h6>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1421 1422 1423 1424 1425 1426 1427 1428 1429 
<pre>
  ...
  &lt;devices&gt;
    &lt;parallel type='pty'&gt;
      &lt;source path='/dev/pts/2'/&gt;
      &lt;target port='0'/&gt;
    &lt;/parallel&gt;
  &lt;/devices&gt;
  ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1430 1431 1432 1433 1434 1435 1436 1437 1438 

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
      specifies the port number. Ports are numbered starting from 1. There are
      usually 0, 1 or 2 parallel ports.
    </p>

    <h6><a name="elementCharSerial">Serial port</a></h6>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1439 1440 1441 1442 1443 1444 1445 1446 1447 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type='pty'&gt;
      &lt;source path='/dev/pts/3'/&gt;
      &lt;target port='0'/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
      specifies the port number. Ports are numbered starting from 1. There are
      usually 0, 1 or 2 serial ports.
    </p>

    <h6><a name="elementCharConsole">Console</a></h6>

    <p>
      This represents the primary console. This can be the paravirtualized
C
qemu: virtio console support  
Cole Robinson 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 
      console with Xen guests, virtio console for QEMU/KVM, or duplicates
      the primary serial port for fully virtualized guests without a
      paravirtualized console.
    </p>

    <p>
      A virtio console device is exposed in the
      guest as /dev/hvc[0-7] (for more information, see
      <a href="http://fedoraproject.org/wiki/Features/VirtioSerial">http://fedoraproject.org/wiki/Features/VirtioSerial</a>)
      <span class="since">Since 0.8.3</span>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1469 1470 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1471 1472 1473 1474 1475 1476 1477 
<pre>
  ...
  &lt;devices&gt;
    &lt;console type='pty'&gt;
      &lt;source path='/dev/pts/4'/&gt;
      &lt;target port='0'/&gt;
    &lt;/console&gt;
C
qemu: virtio console support  
Cole Robinson 已提交
1478 1479 1480 1481 1482 1483 

    &lt;!-- KVM virtio console --&gt;
    &lt;console type='pty'&gt;
      &lt;source path='/dev/pts/5'/&gt;
      &lt;target type='virtio' port='0'/&gt;
    &lt;/console&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1484 1485 
  &lt;/devices&gt;
  ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1486 1487 1488 1489 1490 1491 1492 

    <p>
      If the console is presented as a serial port, the <code>target</code>
      element has the same attributes as for a serial port. There is usually
      only 1 console.
    </p>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
1493 1494 1495 1496 1497 1498 1499 
    <h6><a name="elementCharChannel">Channel</a></h6>

    <p>
      This represents a private communication channel between the host and the
      guest.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1500 1501 1502 1503 1504 1505 1506 
<pre>
  ...
  &lt;devices&gt;
    &lt;channel type='unix'&gt;
      &lt;source mode='bind' path='/tmp/guestfwd'/&gt;
      &lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
    &lt;/channel&gt;
C
docs: domain: Document virtio <channel>  
Cole Robinson 已提交
1507 1508 1509 1510 1511 

    &lt;!-- KVM virtio channel --&gt;
    &lt;channel type='pty'&gt;
      &lt;target type='virtio' name='arbitrary.virtio.serial.port.name'/&gt;
    &lt;/channel&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1512 1513 
  &lt;/devices&gt;
  ...</pre>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 

    <p>
      This can be implemented in a variety of ways. The specific type of
      channel is given in the <code>type</code> attribute of the
      <code>target</code> element. Different channel types have different
      <code>target</code> attributes.
    </p>

    <dl>
      <dt><code>guestfwd</code></dt>
      <dd>TCP traffic sent by the guest to a given IP address and port is
        forwarded to the channel device on the host. The <code>target</code>
        element must have <code>address</code> and <code>port</code> attributes.
        <span class="since">Since 0.7.3</span></dd>
C
docs: domain: Document virtio <channel>  
Cole Robinson 已提交
1528 1529 1530 1531 1532 1533 1534 

      <dt><code>virtio</code></dt>
      <dd>Paravirtualized virtio channel. Channel is exposed in the guest under
        /dev/vport*, and if the optional element<code>name</code> is specified,
        /dev/virtio-ports/$name (for more info, please see
        <a href="http://fedoraproject.org/wiki/Features/VirtioSerial">http://fedoraproject.org/wiki/Features/VirtioSerial</a>)
        <span class="since">Since 0.7.7</span></dd>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
1535 1536 
    </dl>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1537 1538 1539 1540 1541 1542 
    <h5><a name="elementsCharHostInterface">Host interface</a></h5>

    <p>
      A character device presents itself to the host as one of the following
      types.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1543
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1544 
    <h6><a name="elementsCharSTDIO">Domain logfile</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1545 1546 1547 1548 1549 1550 

    <p>
      This disables all input on the character device, and sends output
      into the virtual machine's logfile
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1551 1552 1553 1554 1555 1556 1557 1558 
<pre>
  ...
  &lt;devices&gt;
    &lt;console type='stdio'&gt;
      &lt;target port='1'&gt;
    &lt;/console&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1559 1560
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1561 
    <h6><a name="elementsCharFle">Device logfile</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1562 1563 1564 1565 1566 1567 

    <p>
      A file is opened and all data sent to the character
      device is written to the file.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1568 1569 1570 1571 1572 1573 1574 1575 1576 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="file"&gt;
      &lt;source path="/var/log/vm/vm-serial.log"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1577
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1578 
    <h6><a name="elementsCharVC">Virtual console</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1579 1580 1581 1582 1583 1584 1585 

    <p>
      Connects the character device to the graphical framebuffer in
      a virtual console. This is typically accessed via a special
      hotkey sequence such as "ctrl+alt+3"
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1586 1587 1588 1589 1590 1591 1592 1593 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type='vc'&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1594
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1595 
    <h6><a name="elementsCharNull">Null device</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1596 1597 1598 1599 1600 1601 

    <p>
      Connects the character device to the void. No data is ever
      provided to the input. All data written is discarded.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1602 1603 1604 1605 1606 1607 1608 1609 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type='null'&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1610
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1611 
    <h6><a name="elementsCharPTY">Pseudo TTY</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1612 1613 1614 1615 1616 1617 1618 

    <p>
      A Pseudo TTY is allocated using /dev/ptmx. A suitable client
      such as 'virsh console' can connect to interact with the
      serial port locally.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1619 1620 1621 1622 1623 1624 1625 1626 1627 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="pty"&gt;
      &lt;source path="/dev/pts/3"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1628 1629 1630 

    <p>
      NB special case if &lt;console type='pty'&gt;, then the TTY
A
fix typos in docs  
Atsushi SAKAI 已提交
1631 
      path is also duplicated as an attribute tty='/dev/pts/3'
D
Update domain XML docs  
Daniel P. Berrange 已提交
1632 1633 1634 1635 
      on the top level &lt;console&gt; tag. This provides compat
      with existing syntax for &lt;console&gt; tags.
    </p>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1636 
    <h6><a name="elementsCharHost">Host device proxy</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1637 1638 1639 1640 1641 

    <p>
      The character device is passed through to the underlying
      physical character device. The device types must match,
      eg the emulated serial port should only be connected to
A
fix typos in docs  
Atsushi SAKAI 已提交
1642 
      a host serial port - don't connect a serial port to a parallel
D
Update domain XML docs  
Daniel P. Berrange 已提交
1643 1644 1645 
      port.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1646 1647 1648 1649 1650 1651 1652 1653 1654 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="dev"&gt;
      &lt;source path="/dev/ttyS0"/&gt;
      &lt;target port="1"/&gt;
  &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1655
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1656 
    <h6><a name="elementsCharPipe">Named pipe</a></h6>
C
Fix docs and code disagreements for character devices.  
Cole Robinson 已提交
1657 1658 1659 1660 1661 1662 

    <p>
      The character device writes output to a named pipe. See pipe(7) for
      more info.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1663 1664 1665 1666 1667 1668 1669 1670 1671 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="pipe"&gt;
      &lt;source path="/tmp/mypipe"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
C
Fix docs and code disagreements for character devices.  
Cole Robinson 已提交
1672
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1673 
    <h6><a name="elementsCharTCP">TCP client/server</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1674 1675 1676 

    <p>
      The character device acts as a TCP client connecting to a
G
document tcp listen and raw wire option  
Guido Günther 已提交
1677 
      remote server.
D
Update domain XML docs  
Daniel P. Berrange 已提交
1678 1679 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;protocol type="raw"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
   ...</pre>
G
document tcp listen and raw wire option  
Guido Günther 已提交
1690 1691 1692 1693 1694 

    <p>
      Or as a TCP server waiting for a client connection.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
      &lt;protocol type="raw"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
G
document tcp listen and raw wire option  
Guido Günther 已提交
1705 1706 

    <p>
M
esx: Add support for virtual serial device network backing  
Matthias Bolte 已提交
1707 1708 1709 
      Alternatively you can use <code>telnet</code> instead of <code>raw</code> TCP.
      <span class="since">Since 0.8.5</span> you can also use <code>telnets</code>
      (secure telnet) and <code>tls</code>.
G
document tcp listen and raw wire option  
Guido Günther 已提交
1710 1711 
    <p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;protocol type="telnet"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
    ...
    &lt;serial type="tcp"&gt;
      &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
      &lt;protocol type="telnet"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1728
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1729 
    <h6><a name="elementsCharUDP">UDP network console</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1730 1731 1732 1733 1734 1735 

    <p>
      The character device acts as a UDP netconsole service,
      sending and receiving packets. This is a lossy service.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="udp"&gt;
      &lt;source mode="bind" host="0.0.0.0" service="2445"/&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1746
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1747 
    <h6><a name="elementsCharUNIX">UNIX domain socket client/server</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1748 1749 1750 1751 1752 1753 

    <p>
      The character device acts as a UNIX domain socket server,
      accepting connections from local clients.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1754 1755 1756 1757 1758 1759 1760 1761 1762 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="unix"&gt;
      &lt;source mode="bind" path="/tmp/foo"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1763
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
1764 1765 1766 1767 1768 1769 1770 1771 

    <h4><a name="elementsSound">Sound devices</a></h4>

    <p>
      A virtual sound card can be attached to the host via the
      <code>sound</code> element. <span class="since">Since 0.4.3</span>
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1772 1773 1774 1775 1776 1777 
<pre>
  ...
  &lt;devices&gt;
    &lt;sound model='es1370'/&gt;
  &lt;/devices&gt;
  ...</pre>
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 

    <dl>
      <dt><code>sound</code></dt>
      <dd>
        The <code>sound</code> element has one mandatory attribute,
        <code>model</code>, which specifies what real sound device is emulated.
        Valid values are specific to the underlying hypervisor, though typical
        choices are 'es1370', 'sb16', and 'ac97'
        (<span class="since">'ac97' only since 0.6.0</span>)
      </dd>
    </dl>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 
    <h4><a name="elementsWatchdog">Watchdog device</a></h4>

    <p>
      A virtual hardware watchdog device can be added to the guest via
      the <code>watchdog</code> element.
      <span class="since">Since 0.7.3, QEMU and KVM only</span>
    </p>

    <p>
      The watchdog device requires an additional driver and management
      daemon in the guest.  Just enabling the watchdog in the libvirt
      configuration does not do anything useful on its own.
    </p>

    <p>
      Currently libvirt does not support notification when the
      watchdog fires.  This feature is planned for a future version of
      libvirt.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1810 1811 1812 1813 1814 1815 
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='i6300esb'/&gt;
  &lt;/devices&gt;
  ...</pre>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1816
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1817 1818 1819 1820 1821 1822 
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='i6300esb' action='poweroff'/&gt;
  &lt;/devices&gt;
&lt;/domain&gt;</pre>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1823 1824 1825 1826 

    <dl>
      <dt><code>model</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1827 
        <p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1828 
        The required <code>model</code> attribute specifies what real
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 
        watchdog device is emulated.  Valid values are specific to the
        underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
          <li> 'i6300esb' &mdash; the recommended device,
            emulating a PCI Intel 6300ESB </li>
          <li> 'ib700' &mdash; emulating an ISA iBase IB700 </li>
        </ul>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1840 1841 1842 
      </dd>
      <dt><code>action</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1843 
        <p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1844 
        The optional <code>action</code> attribute describes what
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 
        action to take when the watchdog expires.  Valid values are
        specific to the underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
          <li>'reset' &mdash; default, forcefully reset the guest</li>
          <li>'shutdown' &mdash; gracefully shutdown the guest
            (not recommended) </li>
          <li>'poweroff' &mdash; forcefully power off the guest</li>
          <li>'pause' &mdash; pause the guest</li>
          <li>'none' &mdash; do nothing</li>
H
Update documentation of watchdog dump option and add test data for it  
Hu Tao 已提交
1858 1859 
          <li>'dump' &mdash; automatically dump the guest
            <span class="since">Since 0.8.7</span></li>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1860 1861 
        </ul>
        <p>
H
Update documentation of watchdog dump option and add test data for it  
Hu Tao 已提交
1862 
        Note 1: the 'shutdown' action requires that the guest
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1863 1864 1865 1866 1867 
        is responsive to ACPI signals.  In the sort of situations
        where the watchdog has expired, guests are usually unable
        to respond to ACPI signals.  Therefore using 'shutdown'
        is not recommended.
        </p>
H
Update documentation of watchdog dump option and add test data for it  
Hu Tao 已提交
1868 1869 1870 1871 
        <p>
        Note 2: the directory to save dump files can be configured
        by <code>auto_dump_path</code> in file /etc/libvirt/qemu.conf.
        </p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1872 1873 1874 
      </dd>
    </dl>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
1875 1876 1877 1878 1879 1880 1881 1882 1883 
    <h4><a name="elementsMemBalloon">Memory balloon device</a></h4>

    <p>
      A virtual memory balloon device is added to all Xen and KVM/QEMU
      guests. It will be seen as <code>memballoon</code> element.
      It will be automatically added when appropriate, so there is no
      need to explicitly add this element in the guest XML unless a
      specific PCI slot needs to be assigned.
      <span class="since">Since 0.8.3, Xen, QEMU and KVM only</span>
E
docs: document how to disable memballoon  
Eric Blake 已提交
1884 1885 1886 
      Additionally, <span class="since">since 0.8.4</span>, if the
      memballoon device needs to be explicitly disabled,
      <code>model='none'</code> may be used.
D
Document the memory balloon device  
Daniel P. Berrange 已提交
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 
    </p>

    <p>
      Example automatically added device with KVM
    </p>
<pre>
  ...
  &lt;devices&gt;
    &lt;memballoon model='virtio'/&gt;
  &lt;/devices&gt;
  ...</pre>

    <p>
      Example manually added device with static PCI slot 2 requested
    </p>
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='virtio'/&gt;
    &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/&gt;
  &lt;/devices&gt;
&lt;/domain&gt;</pre>

    <dl>
      <dt><code>model</code></dt>
      <dd>
        <p>
          The required <code>model</code> attribute specifies what type
	  of balloon device is provided. Valid values are specific to
	  the virtualization platform
        </p>
        <ul>
          <li>'virtio' &mdash; default with QEMU/KVM</li>
          <li>'xen' &mdash; default with Xen</li>
        </ul>
      </dd>
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1925 
    <h2><a name="examples">Example configs</a></h2>
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 

    <p>
      Example configurations for each driver are provide on the
      driver specific pages listed below
    </p>

    <ul>
      <li><a href="drvxen.html#xmlconfig">Xen examples</a></li>
      <li><a href="drvqemu.html#xmlconfig">QEMU/KVM examples</a></li>
    </ul>
  </body>
</html>